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

[ftr] Enhance/update help page #471

Closed
daniel-jettka opened this issue Nov 15, 2024 · 2 comments
Closed

[ftr] Enhance/update help page #471

daniel-jettka opened this issue Nov 15, 2024 · 2 comments
Assignees
@krHERO
Labels
Type: feature request
Milestone
1.0.0

Comments

@daniel-jettka
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The help pages are somewhat outdated and need some review

Describe the solution you'd like
Work on add/help - https://github.com/Edirom/Edirom-Online/tree/f8abab67bd86cb055859be8fdb9965602477e854/add/help

Describe alternatives you've considered
remove help - not an option

Additional context
./.
@daniel-jettka
Copy link
Contributor Author

daniel-jettka commented Nov 15, 2024 •
edited by krHERO
Loading

related issues

@daniel-jettka daniel-jettka mentioned this issue Nov 21, 2024
Merged
@krHERO krHERO added this to the 1.0.0 milestone Nov 22, 2024
@krHERO krHERO changed the title [ftr] Enhanced help page [ftr] Enhance/update help page Nov 22, 2024
@krHERO krHERO moved this to In Progress in Edirom Development Nov 25, 2024
@bwbohl bwbohl modified the milestones: 1.0.0, 1.1.0 Dec 4, 2024
krHERO added a commit that referenced this issue Dec 5, 2024
@krHERO
update metadata
b3865ab 
this commit updates the metadata, eg add orcid IDs, update link, delete outdated addresses

Refs #471
krHERO added a commit that referenced this issue Dec 6, 2024
@krHERO
update <front/>, delete Preparation
503d4d8 
this commit updated the <front> text with some simplifications of sentences. Preparation chapter is deleted, because of two reasons. first, it is totally outdated and describes how to install the software from a DVD. Second, how to setup an Edirom locally is described in the docs-directory of the software-repository, the USER help is not an appropriate place for this.

refs #471
@krHERO krHERO mentioned this issue Dec 9, 2024
Closed
@krHERO krHERO modified the milestones: 1.1.0, 1.0.0 Dec 9, 2024
@krHERO krHERO mentioned this issue Dec 9, 2024
Open
krHERO added a commit that referenced this issue Dec 9, 2024
@krHERO
update and correction of text
9e2c2fd 
this commits does a lot of clean up: delete deprecated content (eg installation from DVD), sum up text, delete duplicate text, re-structure, shorten and simplify sentences, move comments to appropriate issues

refs #471
krHERO added a commit that referenced this issue Dec 10, 2024
@krHERO
typos, clean up
0da9868 
this commit corrects some typos and structure

refs #471
krHERO added a commit that referenced this issue Dec 10, 2024
@krHERO
complete update and cleanup
4a1931d 
this commits completely updated the help using the german help-file as a template.

refs #471
@krHERO krHERO mentioned this issue Dec 10, 2024
Merged
daniel-jettka pushed a commit that referenced this issue Dec 11, 2024
@krHERO @daniel-jettka
update metadata
41531d9 
this commit updates the metadata, eg add orcid IDs, update link, delete outdated addresses

Refs #471
daniel-jettka pushed a commit that referenced this issue Dec 11, 2024
@krHERO @daniel-jettka
update <front/>, delete Preparation
c0dc848 
this commit updated the <front> text with some simplifications of sentences. Preparation chapter is deleted, because of two reasons. first, it is totally outdated and describes how to install the software from a DVD. Second, how to setup an Edirom locally is described in the docs-directory of the software-repository, the USER help is not an appropriate place for this.

refs #471
daniel-jettka pushed a commit that referenced this issue Dec 11, 2024
@krHERO @daniel-jettka
update and correction of text
3a12fd3 
this commits does a lot of clean up: delete deprecated content (eg installation from DVD), sum up text, delete duplicate text, re-structure, shorten and simplify sentences, move comments to appropriate issues

refs #471
daniel-jettka pushed a commit that referenced this issue Dec 11, 2024
@krHERO @daniel-jettka
typos, clean up
2aa5929 
this commit corrects some typos and structure

refs #471
daniel-jettka pushed a commit that referenced this issue Dec 11, 2024
@krHERO @daniel-jettka
complete update and cleanup
eb5569c 
this commits completely updated the help using the german help-file as a template.

refs #471
@krHERO
Copy link
Member

krHERO commented Dec 11, 2024

closed with #497

@krHERO krHERO closed this as completed Dec 11, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Edirom Development Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@krHERO krHERO

Labels
Type: feature request
Projects
Edirom Development
Status: Done
Milestone
1.0.0
Development

No branches or pull requests
3 participants
@bwbohl @krHERO @daniel-jettka