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

update elektra-glossary.md #3240

Closed
3 tasks
markus2330 opened this issue Nov 17, 2019 · 5 comments · Fixed by #3596
Closed
3 tasks

update elektra-glossary.md #3240

markus2330 opened this issue Nov 17, 2019 · 5 comments · Fixed by #3596
Assignees

Comments

@markus2330
Copy link
Contributor

markus2330 commented Nov 17, 2019

Following is not explained in doc/help/elektra-glossary.md

  • key name
  • key base name
  • key name part

@kodebach can you do this within #3115 once it is settled?

@kodebach
Copy link
Member

Will do

@stale
Copy link

stale bot commented Nov 16, 2020

I mark this issue stale as it did not have any activity for one year. I'll close it in two weeks if no further activity occurs. If you want it to be alive again, ping the issue by writing a message here or create a new issue with the remainder of this issue.
Thank you for your contributions 💖

@stale stale bot added the stale label Nov 16, 2020
@markus2330 markus2330 removed the stale label Nov 17, 2020
@kodebach
Copy link
Member

See #3596. Note: I did not add "empty base name", because I don't think it's important enough to be included in the glossary. Without going into details about key name structure and escaped vs. unescaped name, empty key name parts also can really be explained.

In general I think, we should try to compact and slim down our documentation and not duplicate information. Elektra's documentation is already harder to navigate than some of the code base. Adding small pieces of information everywhere doesn't help users find what the are looking for.

@mpranj
Copy link
Member

mpranj commented Dec 17, 2020

In general I think, we should try to compact and slim down our documentation and not duplicate information. Elektra's documentation is already harder to navigate than some of the code base. Adding small pieces of information everywhere doesn't help users find what the are looking for.

I agree that this is an important point.

@markus2330
Copy link
Contributor Author

Yes I agree, if we already have such pieces of information somewhere else (like in the key name docu) it is better to only refer to the place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants