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.

Sign up for GitHub

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

Jump to bottom

move docu from wiki to docs (enhance HowTo for customising) #415

Closed
bwbohl opened this issue Sep 6, 2024 · 5 comments
Closed

move docu from wiki to docs (enhance HowTo for customising) #415

bwbohl opened this issue Sep 6, 2024 · 5 comments
Assignees
@krHERO
Labels
Area: Documentation
Milestone
1.0.0

Comments

@bwbohl
Copy link
Member

bwbohl commented Sep 6, 2024 •
edited
Loading

A first draft for the easy ways of customising, e.g. via edition-specific CSS should be provided. And maybe some hints to advanced possibilities.
@bwbohl bwbohl converted this from a draft issue Sep 6, 2024
@bwbohl bwbohl added this to the 1.0.0 milestone Sep 6, 2024
@krHERO
Copy link
Member

krHERO commented Sep 6, 2024

a placeholder for this topic is already existing in the wiki since some years ;)

@bwbohl bwbohl mentioned this issue Sep 30, 2024
Closed
@bwbohl bwbohl moved this from New to Backlog in Edirom Development Oct 9, 2024
@bwbohl
Copy link
Member Author

bwbohl commented Oct 9, 2024 •
edited by krHERO
Loading

Well then, could all @Edirom/edirom-online-developer members please start filling in some bullet points about how they customise Edirom Online in their projects?

Although I wouldn’t say I like the wiki too much, as it always feels a bit like a sidekick project, maybe we could at least provide some starting points there in a way that does not call for complete coverage of all customisation options. Just as a start!

@bwbohl
Copy link
Member Author

bwbohl commented Oct 11, 2024

@riedde thanks for adding som info on the preferences to the wiki page

@krHERO
Copy link
Member

krHERO commented Nov 13, 2024 •
edited
Loading

hi benni, i agree, the wiki does not feel like the best place to have this kind of information captured. i will start to move the technical documentation from the wiki to a dedicated edirom-online/docs folder in the repo with subfolders

  • setup Edirom Online on local machine (ESS2024: DennisR, Tobias)
  • customization of Edirom Online and data (wiki)
  • release workflow (wiki, by DennisR)
  • old (mostly deprecated) documentation from wiki (prepare content with Edirom Editor etc)

at the moment information is a little mixed up in the wiki. so by moving, i try to create a better structure and add some more info where possible. the stuff, that is still valid will be taken to the "active" docs section.
i will also move the very old docu stuff to the new place "docs" to have it once captured in the v1.0.0 release with some contextual information. but i want to delete the very old docu stuff (especially regarding installing deprecated versions etc) for future releases to make sure the docs are always valid with their current releases.

with the wiki being empty i suggest to use it for capturing informations regarding our community meetings.

@krHERO krHERO changed the title Add a HowTo for customising Edirom Online move docu from wiki to docs (enhance HowTo for customising) Nov 13, 2024
krHERO added a commit to krHERO/Edirom-Online that referenced this issue Nov 14, 2024
@krHERO
move release workflow from wiki to docs
de647a6 
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
krHERO added a commit to krHERO/Edirom-Online that referenced this issue Nov 14, 2024
@krHERO
move customize content from wiki to docs
b6012ec 
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
krHERO added a commit to krHERO/Edirom-Online that referenced this issue Nov 14, 2024
@krHERO
add toc
c1be983 
since the file has several topics and subtopics this commit adds a table of content.

Refs Edirom#415
krHERO added a commit to krHERO/Edirom-Online that referenced this issue Nov 14, 2024
@krHERO
Update release-workflow.md
d42b48c 
minor typo

Refs Edirom#415
krHERO added a commit to krHERO/Edirom-Online that referenced this issue Nov 14, 2024
@krHERO
create setup.md
e6fc574 
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
krHERO added a commit to krHERO/Edirom-Online that referenced this issue Nov 15, 2024
@krHERO
move old (deprecated) technical documentation from wiki to edirom-onl…
a7f9476 
…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
@krHERO krHERO mentioned this issue Nov 15, 2024
Merged
krHERO added a commit to krHERO/Edirom-Online that referenced this issue Nov 21, 2024
@krHERO
Update README.md regarding documentation links
3941caf 
this commit adds a subtopic "documentation" that links to /docs in this repo. addresses a comment by @peterstadler  Edirom#472 (review)

Refs #Edirom#415
krHERO added a commit that referenced this issue Nov 22, 2024
@krHERO
Ftr/415 move docu from wiki to docs (#472)
09ea820 
## Description, Context and related Issue
<!--- Please describe your changes. Why is this change required? What
problem does it solve? -->
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
)

<!--- This project only accepts pull requests related to open issues.
Please link to the issue here: -->
Refs #415 

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you
ran. -->
I did a self-review of the text.

## Types of changes
<!--- What types of changes does your code introduce? Please DELETEE
options that are not relevant. -->
- Documentation Update
- Improvement

## Overview
<!--- Go over all the following points, and DELETE options that are not
relevant. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
- I have read the
[CONTRIBUTING](https://github.com/Edirom/Edirom-Online/blob/develop/CONTRIBUTING.md)
document.
@krHERO
Copy link
Member

krHERO commented Nov 22, 2024

is closed by #472

@krHERO krHERO closed this as completed Nov 22, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in Edirom Development Nov 22, 2024
Diginaut pushed a commit to korngold-werkausgabe/Edirom-Online_EWK-WA that referenced this issue Dec 16, 2024
@krHERO
move release workflow from wiki to docs
4cc1c22 
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
Diginaut pushed a commit to korngold-werkausgabe/Edirom-Online_EWK-WA that referenced this issue Dec 16, 2024
@krHERO
move customize content from wiki to docs
2278ad6 
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
Diginaut pushed a commit to korngold-werkausgabe/Edirom-Online_EWK-WA that referenced this issue Dec 16, 2024
@krHERO
add toc
1eb3652 
since the file has several topics and subtopics this commit adds a table of content.

Refs Edirom#415
Diginaut pushed a commit to korngold-werkausgabe/Edirom-Online_EWK-WA that referenced this issue Dec 16, 2024
@krHERO
Update release-workflow.md
4b5359a 
minor typo

Refs Edirom#415
Diginaut pushed a commit to korngold-werkausgabe/Edirom-Online_EWK-WA that referenced this issue Dec 16, 2024
@krHERO
create setup.md
6ae8559 
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
Diginaut pushed a commit to korngold-werkausgabe/Edirom-Online_EWK-WA that referenced this issue Dec 16, 2024
@krHERO
move old (deprecated) technical documentation from wiki to edirom-onl…
b106822 
…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
Diginaut pushed a commit to korngold-werkausgabe/Edirom-Online_EWK-WA that referenced this issue Dec 16, 2024
@krHERO
Update README.md regarding documentation links
c15d1cc 
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
Assignees

@krHERO krHERO

Labels
Area: Documentation
Projects
Edirom Development
Status: Done
Milestone
1.0.0
Development

No branches or pull requests
2 participants
@bwbohl @krHERO