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

Create Tutorial for End Users #2332

Open
markus2330 opened this Issue Jan 23, 2019 · 4 comments

Comments

Projects
None yet
2 participants
@markus2330
Copy link
Contributor

markus2330 commented Jan 23, 2019

The tutorial should explain, based on the example of LCDproc, how an application (LCDproc) can be configured with Elektra. Following ways should be part of the tutorial:

  • "kdb editor"
  • "kdb set"
  • "kdb qt-gui" (as embedded video?)
  • "kdb run-web" (as embedded video?)

What the tutorial describes should be useful (LCDproc users might actually want to reconfigure as described). Ideally, all changes together make some sense. Quirks should not be described, but instead issues should be opened describing what did not work.

Target Audience: People that never heard of Elektra.

The tutorial should also explain how to introspect the specification (e.g. to find out of which type a configuration setting is).

Please use terminology from ./doc/help/elektra-glossary.md

Note: https://www.libelektra.org/news/elektrify-lcdproc is basically the list of promises we made.

Further input of what the tutorial should contain is very much welcomed.

@Piankero If anything is unclear, please ask here.

@markus2330 markus2330 added this to the 0.8.26 milestone Feb 6, 2019

@markus2330

This comment has been minimized.

Copy link
Contributor Author

markus2330 commented Feb 6, 2019

Any progress here?

@Piankero

This comment has been minimized.

Copy link
Contributor

Piankero commented Feb 6, 2019

Will implement it from Sunday until Tuesday :)

@Piankero

This comment has been minimized.

Copy link
Contributor

Piankero commented Feb 11, 2019

As of now I can only write a useful tutorial for kdb set and kdb editor as both available guis do not integrate with specifications very well and would just confuse users when they use it in my opinion.
I linked all issues above.
I will write the first version tomorrow for you to have a review on.

@Piankero

This comment has been minimized.

Copy link
Contributor

Piankero commented Feb 13, 2019

The first version is available in the PR: ElektraInitiative/lcdproc#5

Unfortunately the kdb editor is also not useable because it cannot update any configuration setting without failing or even breaking the configuration

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