search

profclems / glab

The GitLab CLI tool. Archived: now officially adopted by GitLab as the official CLI tool and maintained at https://gitlab.com/gitlab-org/cli. See https://github.com/profclems/glab/issues/983
https://glab.readthedocs.io/
MIT License
2.08k stars 163 forks source link

[GLAB]: Better documentation website #669

Open profclems opened 3 years ago

profclems commented 3 years ago

GLab as a popular interactive CLI tool deserves a better documentation website and a custom domain name. Currently, the docs are hosted on Readthedocs as https://glab.readthedocs.io. The current docs doesn't really help much and doesn't really complement an interactive CLI tool.

There are plans underway to write a better documentation website and host it on GitLab pages.

If we are able to get backers donate to our collective, we will purchase a domain name for glab (glab-cli.io)

Inspirations: https://cli.github.com/ https://httpie.io

profclems commented 3 years ago

Started working on the documentation site

Repo: https://github.com/profclems/glab-docs Site: https://glab-cli.netlify.app

TODO:

jeanphi-baconnais commented 3 years ago

Hi @profclems , what do you think about GitLab Pages to save documentation ?

profclems commented 3 years ago

@jeanphibaconnais I actually want to host the documentation site on GitLab pages. I haven't hosted on GitLab pages before. I'm open if you'd like to help

olearycrew commented 3 years ago

Hello @profclems! My name is Brendan from GitLab (I work for John Coghlan).

Wanted to demo how you could do it - so I cloned the "new" docs repo to a GitLab repo and added a .gitlab-ci.yml to show how to deploy to pages. There's one thing I would need to still work out as the CSS is assuming it is at the root (which it is not). I'm sure I could solve this if I learn Hugo a little.

The keys are:

You can see the repo here, the deployed pages are at https://oleary.gitlab.io/glab-docs/. You can also learn more about Pages in our docs here.

I'd be happy to help either move the current docs or get the new doc site deployed to GitLab Pages.

jeanphi-baconnais commented 3 years ago

@profclems yes i use GitLab Pages with Hugo so i can help. Like @olearycrew said and did, it's easy to deploy one site 😄

jeanphi-baconnais commented 3 years ago

Hi @profclems , do you want to use your group in GitLab to create GitLab Pages ? https://gitlab.com/glab-cli

profclems commented 3 years ago

Yes @jeanphibaconnais... I'm even thinking of moving glab to glab-cli group namespace on both GitLab and GitHub

jeanphi-baconnais commented 3 years ago

Cool 😄 so i will can help you on this part if you need some help 😄

clemsbot commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. We haven't had the time to address it yet, but we want to keep it open. This message is just a reminder for us to help triage issues.

jeanphi-baconnais commented 3 years ago

Hi @profclems , on GitLab, do you want some help to create a project for documentation ?

clemsbot commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. We haven't had the time to address it yet, but we want to keep it open. This message is just a reminder for us to help triage issues.