Hugo website using docsy theme #1851
Conversation
There was a problem hiding this comment.
Good job @cyriltovena ! I left few comments, plus:
- Some pages, like https://cortexmetrics.io/docs/configuration/, report
Last modified January 1, 0001 - Dashboards have been moved to
k8s/dashboards/but why thek8sroot folder? I can't see anything Kubernetes specific: they're just Grafana dashboards - Links in https://cortexmetrics.io/docs/ open in a new tab, which looks weird for internal links like the ones in the Documentation section (https://cortexmetrics.io/docs/#documentation)
|
Thanks @pracucci for the review, to be honest I tried to rush this as this was an urgent task, been a while we are waiting for a website. I think the idea is to set the first stones and build on it. I'll try to get your feedback in. |
@pracucci I think it will get fixed as soon as we merge this PR. I think hugo get the git commit when building. I still have to look at how to push to |
I couldn't find a better folder for it. Do you prefer to create a new root folder ? I need to move them out of the docs. |
I couldn't find how to control this. It seems that Hugo is making all doc content link, blank ones. |
cyriltovena
force-pushed
the
website-v2
branch
from
6999483 to
9e38df3
Compare
What's about |
|
Alright it's all ready for deployment, I have a sync today with Jacob to setup credentials and test this. |
cyriltovena
force-pushed
the
website-v2
branch
7 times, most recently
from
4ee18ba to
6755299
Compare
|
/cc @gouthamve This is ready. |
cyriltovena
force-pushed
the
website-v2
branch
from
16c1561 to
5db5f20
Compare
The website is built using hugo and google docsy theme. A special theme for open source content. The docs are copied over from the docs folder and massaged during the `web-pre` target to make them more Hugo friendly. All you have to do is keep writing docs in the `docs/` folder. The changelog and the governance document are also copied. New target have been added: - `web-build` rebuilds the website. - `web-pre` move docs to website/content/en/docs and apply some pre-processing for fixing md and links. - `web-deploy` deploy the website mainly used by CI. - `web-serve` serve the website locally, don't forget to `web-pre` first to get the doc moved. Signed-off-by: Tom Wilkie <[email protected]> Signed-off-by: Cyril Tovena <[email protected]>
Signed-off-by: Cyril Tovena <[email protected]>
Signed-off-by: Cyril Tovena <[email protected]>
cyriltovena
force-pushed
the
website-v2
branch
from
5db5f20 to
ef00bb1
Compare
Hello !
This PR introduces a cortex website already deployed at https://cortexmetrics.io/, I don't think the last version is deployed /cc @tomwilkie I've added a lot of fixes for mobile users and the changelog.
The site is built using hugo.io and google docsy a special theme for open source content and documentation.
The website is based on the
docs/folder, it is moved towebsite/content/en/docsthen we run a small tool (tools/website.go) to fixup the markup language.To sync the docs use
web-pre, to build the website useweb-build, to run locally useweb-server.I've also updated the build image to include necessary tools to build the website. The CI has a new target to verify that the documentation and the website is in sync.
Let me know !