New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation site #974
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple comments, but this looks great!
Is there a good way to deploy this to a github site just to check that CI works before merging? Locally everything looked nice.
.github/workflows/github-pages.yaml
Outdated
name: Deploy Documentation to Github Pages | ||
|
||
on: | ||
# Runs on pushes targeting the 1.0.x branch |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This comment can be removed since we don't have a 1.0.x branch.
weight: 7 | ||
--- | ||
|
||
# Labels |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's probably worth having Labels as a separate item since they are a core part of using this library.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved labels and exemplars to their own section. ## Disabling _created metrics
is now in the _index.md
of instrumenting. I can change if need it.
If I'm not mistaken, the only way to deploy to pages is syncing with a github branch. @fstab did you try to manually deploy the docs? or you just used the github action directly? |
I just used the Github action. I didn't even write it, I just copied it out of the Hugo documentation :) https://gohugo.io/hosting-and-deployment/hosting-on-github/ |
There were some readme updates that came in with allowing https, would you be willing to rebase this with those new changes? Otherwise I think this looks good and I can work on any deployment issues in followup PRs if necessary. |
Signed-off-by: Marc Tuduri <marctc@protonmail.com>
Signed-off-by: Marc Tuduri <marctc@protonmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple tiny comments, plus the most recent commit needs a DCO signoff.
Signed-off-by: Marc Tuduri <marctc@protonmail.com>
Signed-off-by: Marc Tuduri <marctc@protonmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
In a follow-up PR, I can add Python docstrings of the documented classes. But for the scope of this PR I decided to leave it out.
Fixes #849
This a preview how it renders: