docs: refactor pages and rewrite installation #1014
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
esoubiran-aneo
added
the
Documentation
esoubiran-aneo
commented
Apr 20, 2023
.docs/content/0.armonik/components/3.armonik/2.compute-plane.md
Outdated
Show resolved
Hide resolved
This comment was marked as resolved.
This comment was marked as resolved.
esoubiran-aneo
requested review from
ddubuc,
wkirschenmann,
lzianekhodja-aneo,
aneojgurhem,
lemaitre-aneo,
jfonseca-aneo,
ngruelaneo,
dbrasseur-aneo and
alouvion-aneo
This comment was marked as resolved.
This comment was marked as resolved.
|
I'm even wondering if most of this doc should be in core and we link to core |
aneojgurhem
reviewed
Apr 24, 2023
There was a problem hiding this comment.
should be in the control plane if we speak about the one that tells the number of tasks in each status
There was a problem hiding this comment.
I don't know. I juste move content from this file: https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/localhost/README.md#introduction
dbrasseur-aneo
requested changes
Apr 24, 2023
.docs/content/0.armonik/components/2.monitoring/5.metrics-server.md
Outdated
Show resolved
Hide resolved
.docs/content/0.armonik/components/3.armonik/1.control-plane.md
Outdated
Show resolved
Hide resolved
.docs/content/0.armonik/components/3.armonik/2.compute-plane/1.polling-agent.md
Show resolved
Hide resolved
infrastructure/utils/scripts/installation/prerequisites/install-k3s.sh
Outdated
Show resolved
Hide resolved
We need to explain ArmoniK to new users. I think that Core is not the entry point. |
Co-authored-by: Dylan Brasseur <[email protected]>
Co-authored-by: Dylan Brasseur <[email protected]>
Co-authored-by: Dylan Brasseur <[email protected]>
Co-authored-by: Dylan Brasseur <[email protected]>
Co-authored-by: Dylan Brasseur <[email protected]>
…l-k3s.sh Co-authored-by: Dylan Brasseur <[email protected]>
Co-authored-by: Dylan Brasseur <[email protected]>
Co-authored-by: Dylan Brasseur <[email protected]>
.docs/content/0.armonik/components/2.monitoring/5.metrics-server.md
Outdated
Show resolved
Hide resolved
…er.md Co-authored-by: Dylan Brasseur <[email protected]>
dbrasseur-aneo
requested changes
Apr 25, 2023
Co-authored-by: Dylan Brasseur <[email protected]>
dbrasseur-aneo
approved these changes
Apr 28, 2023
|
Kudos, SonarCloud Quality Gate passed!
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to refactor the documentation to facilitate the understanding of ArmoniK and to update script (corresponding to the update documentation).
To-do
Components explanationsMove to Explain components in ArmoniK #1035armonik_dev_environment.ps1script (now that documentation is cristal clear and systemd exist, we no longer need to maintain this script)Rework guidesMove to Rework guides #1037Explanation
The main goal of this refactoring was to simplify and unify documentation on how a new user could install ArmoniK.
Documentation have now an installation section to easily find how to install ArmoniK without navigating through many folders from the GitHub UI.
Then, I added a way to install ArmoniK using the new native
systemdin wsl2.And, because of code duplication, I unified the prerequisites installation script into a single file. Each program is in a separate file in order to facilitate understanding and updates. This modularity allows the user to install only the program needed.
Fix
fix #1018
fix #1015
fix #1012
fix #821