Skip to content
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 commit SHA to the datasheet(s) #33

Closed
umarcor opened this issue May 21, 2021 · 1 comment · Fixed by #41
Closed

Add commit SHA to the datasheet(s) #33

umarcor opened this issue May 21, 2021 · 1 comment · Fixed by #41
Labels
DOC Improvements or additions to documentation

Comments

@umarcor
Copy link
Collaborator

umarcor commented May 21, 2021

Since the datasheet is uploaded automatically from CI, multiple artifacts/assets might be difficult to tell apart. It would be desirable to have the commit SHA added to the frontpage/subtitle of the PDF and HTML datasheets, so that users can know which specific version of the repo they correspond to. It can also be useful for developers to understand bug reports or feature requests from users with probably outdated versions of the documentation.

However, I did not search how to do it with asciidoc(tor) yet. I'm creating this issue as a remainder.

@stnolting
Copy link
Owner

If asciidoc supports this, this idea would be a nice add-on!

@stnolting stnolting added the DOC Improvements or additions to documentation label May 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOC Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants