[GLAB]: Better documentation website

[profclems]

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]

Started working on the documentation site

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

TODO:

• [ ] Fix /cmd/gen-docs to generate markdown files instead of rst
• [ ] Set up CI to build docs and push to glab-docs repo
• [ ] Purchase domain name - glab-cli.dev or glab-cli.io

[jeanphi-baconnais]

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

[profclems]

@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]

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:

• It is a special job named pages:
• You have to have the final HTML/CSS/JS be in a single folder named public
• You add that as an artifact.

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]

@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]

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

[profclems]

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

[jeanphi-baconnais]

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

[clemsbot]

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]

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

[clemsbot]

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.