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
doc: add glossaries for contrib and dev #4810
Conversation
The aim of this PR is to add two new glossaries, one for |
Feel free, however, to suggest stuff I can put in there before merging. |
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.
I think both Hooks and Change Tracking are terms even end users will be confronted with. So doc/help/elektra-glossary.md should be fine for these terms. Change Tracking is a feature for admins after all, not for devs or contributors.
Most of the technical concepts in doc/help/elektra-glossary.md, however, probably should be moved to dev/.
There were other terms that were used in the UI descriptions, which are not present here. As it is quite some time ago, I don't remember them anymore. One was session but this term in specific should be irrelevant now?
Well, Change Tracking is something internal to
Agree, but should I move the linked files also? That would mean that we lose manpages for those concepts.
I'd much rather add those terms in the appropriate PRs. |
@atmaxinger There is a manpage version of the glossary, so you need to run |
f312206
to
2b1d546
Compare
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.
LGTM
@atmaxinger maybe this for release, too? |
Basics
(added as entry in
doc/news/_preparation_next_release.md
whichcontains
_(my name)_
)Please always add something to the release notes.
(first line should have
module: short statement
syntax)close #X
, are in the commit messages.doc/news/_preparation_next_release.md
scripts/dev/reformat-all
Checklist
(not in the PR description)
Review
Labels