Skip to content
This repository has been archived by the owner on Dec 21, 2021. It is now read-only.

Added first version of Readme #35

Merged
merged 11 commits into from
Jan 25, 2021
Merged

Conversation

soenkeliebau
Copy link
Member

This also contains preliminary code to generate documentation of the command line parameters from our parameter definition in the source code.

It is not the final version, as the doc is currently being generated every time the agent is executed, which we definitely do not want to happen!

The text portions of this PR are ready for review, but the code part I'll rework over the next days.

README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
src/agentconfig.rs Outdated Show resolved Hide resolved
src/agentconfig.rs Outdated Show resolved Hide resolved
src/agentconfig.rs Outdated Show resolved Hide resolved
src/agentconfig.rs Outdated Show resolved Hide resolved
src/agentconfig.rs Outdated Show resolved Hide resolved
@lfrancke
Copy link
Member

One general comment: The readme doesn't really explain what this thing does.
I have a feeling you already need to know what it does for the readme to be helpful.

See https://github.com/virtual-kubelet/systemk for example.
We could write: "This is a kubelet that uses systemd as its backend instead of the usual containers." etc.

src/bin/generate_doc.rs Outdated Show resolved Hide resolved
src/agentconfig/mod.rs Outdated Show resolved Hide resolved
src/bin/generate_doc.rs Outdated Show resolved Hide resolved
Also renamed agentconfig module to config as this was repeated verbatim in the struct name AgentConfig.
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
src/bin/generate_doc.rs Outdated Show resolved Hide resolved
src/config/mod.rs Outdated Show resolved Hide resolved
src/bin/generate_doc.rs Outdated Show resolved Hide resolved
Stackable automation moved this from In progress to Review in progress Jan 25, 2021
@lfrancke lfrancke added this to the Milestone #1 milestone Jan 25, 2021
Stackable automation moved this from Review in progress to To be merged Jan 25, 2021
@soenkeliebau soenkeliebau merged commit 0e838b5 into stackabletech:main Jan 25, 2021
Stackable automation moved this from To be merged to Done Jan 25, 2021
@soenkeliebau soenkeliebau deleted the readme branch January 25, 2021 21:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants