Ftr/415 move docu from wiki to docs #472
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
we want to move all information regarding (technical) documentation to edirom-online/docs from the wiki. description of release workflow is a part of this. Refs #Edirom#415
we want to move all information regarding (technical) documentation to edirom-online/docs from the wiki. description of customization is a part of this. The content was taken from several places in the wiki and integrated to a newly introduced structure of this file. Refs Edirom#415
since the file has several topics and subtopics this commit adds a table of content. Refs Edirom#415
minor typo Refs Edirom#415
this commit adds a detailed setup description for Edirom-Online and a data package. It is more detailed than in the readme.md to make every step as clear as possible, since the readme.md instructions are fine for advanced developers that need only a short and quick description. thanks to @feuerbart for capturing this during the edirom-summer-school 2024. i corrected only some minor typos and changed only a little bit regarding the structure. Refs Edirom#415
…ine/docs to have this information captured once before it will be updated by future releases, it will be saved with this commit. The documentation was written 2015–2017. Refs Edirom#415
this commit adds a subtopic "documentation" that links to /docs in this repo. addresses a comment by @peterstadler Edirom#472 (review) Refs #Edirom#415
|
see 3941caf i added a subtopic to the main readme.md and listet the links to the content of the docs-folder. do you agree on this idea? |
daniel-jettka
approved these changes
Nov 21, 2024
There was a problem hiding this comment.
Also did not check details of content (we have the separate #471 for this).
In general looks fine to me.
Thanks :-)
This was referenced Nov 22, 2024
Diginaut
pushed a commit
to korngold-werkausgabe/Edirom-Online_EWK-WA
that referenced
this pull request
Dec 16, 2024
this commit adds a subtopic "documentation" that links to /docs in this repo. addresses a comment by @peterstadler Edirom#472 (review) Refs #Edirom#415
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.
Description, Context and related Issue
I moved the content (technical documentation) from the wiki to
edirom-online/docs. The community agreed, the place does not fit best for the technical documentation and it is not under version control. A very good plus by cleaning the wiki while moving its content to a more suitable place is that we can capture the information regarding edirom community at the wiki now. I plan to delete the content of the wiki after this PR is reviewed and merged.four files were created in edirom-online/docs
docs/customize.md, information from different subtopics of the old wiki-content were collected in this one file (created by @riedde and @nikobeer , still valid)docs/old-deprecated-documentation-from-wiki.md, copy/paste the old sections without updates (created by @nikobeer and @bwbohl , deprecated, should be removed in releases after v1.0.0)docs/release-workflow.md, was moved from the wiki (still valid, created 2022 by @riedde )docs/setup.md, was added initially (created at ESS2024 by @feuerbart )Refs #415
How Has This Been Tested?
I did a self-review of the text.
Types of changes
Overview