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

Documentation: Add Basic Storage Plugin Tutorial #2479

Merged
merged 9 commits into from Mar 14, 2019

Conversation

Projects
None yet
2 participants
@sanssecours
Copy link
Member

sanssecours commented Mar 11, 2019

No description provided.

TODO: Describe difference between keys that store null values (binary data) and empty values (string data)
TODO: Describe how to store arrays properly (`array` metadata): Just add a link to `arrays.md`
TODO: Add information on how plugins should store comment (meta)data
TODO: Document that a plugin should keep the ordering of key-value pairs of a document intact, when writing data back to the configuration file

This comment has been minimized.

@markus2330

markus2330 Mar 11, 2019

Contributor

Thank you, this will get a very beautiful tutorial!

One more (important) aspect is of relative keys #51.

It is already very helpful as-is but maybe you can also add information about plugins like directoryvalue.

@sanssecours sanssecours force-pushed the sanssecours: branch 2 times, most recently from 7cdfaf0 to d4053a9 Mar 11, 2019

@markus2330
Copy link
Contributor

markus2330 left a comment

Thank you very nice tutorial! Unfortunately a rebase is required. Can we somehow split up the release notes even more? (e.g. new lines between the `<>``?) It seems like a lot of conflicts are created now.

- [arrays](arrays.md), and
- [metadata](../dev/metadata.md),

takes more work. Before you continue with this text, please make sure that you read all of the linked documents.

This comment has been minimized.

@markus2330

markus2330 Mar 13, 2019

Contributor

The linked documents above?

- `user/tests/storage/root/level1`, or
- `user/tests/storage/root/level1/level2`

to the key set. One plugin that handles this situation properly is [YAML CPP](/src/plugins/yamlcpp/), as the following [Markdown Shell Recorder test](https://master.libelektra.org/tests/shell/shell_recorder/tutorial_wrapper) shows:

This comment has been minimized.

@markus2330

markus2330 Mar 13, 2019

Contributor

You could also link to doc/decisions/holes.md here.

sanssecours added some commits Mar 11, 2019

@sanssecours sanssecours force-pushed the sanssecours: branch from d4053a9 to b4bc603 Mar 13, 2019

@sanssecours

This comment has been minimized.

Copy link
Member Author

sanssecours commented Mar 13, 2019

Can we somehow split up the release notes even more? (e.g. new lines between the <>?) It seems like a lot of conflicts are created now.

Something that would help, but also feels a little bit ridiculous would be to tell everyone to insert an item into the list under the header ## Documentation alphabetically, based on their (first or last) name. So, for example, Adam Apple would add all his news items before Marie Currie, which in term would add her items before Zaira Voltaire. Another strategy could be to just add new news items at a random position of the list.

Anyway, merge conflicts happen in any project. While they are daunting at the beginning, they usually should be resolvable, if you rebases on master regularly.

@markus2330

This comment has been minimized.

Copy link
Contributor

markus2330 commented Mar 13, 2019

I thought about to make the lists simply longer and to use random positions.

@markus2330 markus2330 merged commit 0f9f894 into ElektraInitiative:master Mar 14, 2019

6 checks passed

LGTM analysis: C/C++ No new or fixed alerts
Details
LGTM analysis: JavaScript No code changes detected
Details
LGTM analysis: Python No code changes detected
Details
continuous-integration/jenkins/pr-merge This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage decreased (-0.0009%) to 76.897%
Details
@markus2330

This comment has been minimized.

Copy link
Contributor

markus2330 commented Mar 14, 2019

Thank you for starting this very nice tutorial, I like it very much already.

@sanssecours sanssecours deleted the sanssecours:📚 branch Mar 14, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.