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.

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

docs: Update the user guide (DEV-1049) #769

Merged
merged 32 commits into from Jul 19, 2022
Merged

Conversation

flavens
Copy link
Contributor

@flavens flavens commented Jun 22, 2022

resolves DEV-1049

@flavens flavens self-assigned this Jun 22, 2022
@flavens flavens requested a review from mdelez as a code owner Jun 22, 2022
mdelez
mdelez approved these changes Jun 22, 2022
@flavens flavens marked this pull request as draft Jun 22, 2022
flaurens and others added 25 commits Jun 22, 2022
@flavens flavens marked this pull request as ready for review Jul 13, 2022
@flavens
Copy link
Contributor Author

flavens commented Jul 13, 2022

@mdelez I may have missed some things. Please, let me know!

@mdelez
Copy link
Collaborator

mdelez commented Jul 14, 2022

your changes look good :)

I found some small things to change:

/user-guide/project

Screen Shot 2022-07-13 at 16 20 23

selecet -> select

Screen Shot 2022-07-13 at 16 20 35

since the example uses english, I think the labels in the resource of this image should be in english as well

Screen Shot 2022-07-14 at 10 01 58

something is wrong with the formatting here

/user-guide/system

Screen Shot 2022-07-14 at 10 15 30

has no more -> no longer has

/user-guide/data

Screen Shot 2022-07-14 at 10 26 12

the smaller will be the resource viewer for each -> the smaller the resource viewer for each will be

some general notes

  • We seem to be sticking with American english so all occurrences of "centre" should change to "center"
  • I would advise against adding "Not yet implemented" notes in the docs because there's no telling when those features will be implemented and it looks a bit bad if it stays in the docs for years.

@flavens
Copy link
Contributor Author

flavens commented Jul 14, 2022

@mdelez concerning the screenshot with the classes Buch/Buchseite, my user account is in English and we always get the label in German (why?!) so I cannot change it now.

@mdelez
Copy link
Collaborator

mdelez commented Jul 14, 2022

@mdelez concerning the screenshot with the classes Buch/Buchseite, my user account is in English and we always get the label in German (why?!) so I cannot change it now.

hmm strange...is there an english label? Otherwise you could just make the resource again just for the screenshot. It's not a big issue but consistency is nice :)

@flavens
Copy link
Contributor Author

flavens commented Jul 14, 2022

@mdelez concerning the screenshot with the classes Buch/Buchseite, my user account is in English and we always get the label in German (why?!) so I cannot change it now.

hmm strange...is there an english label? Otherwise you could just make the resource again just for the screenshot. It's not a big issue but consistency is nice :)

The thing is: even when we have English and German labels, the German one is displayed by default. Like the list label order issue, you fixed... Should I report it? I did a test locally and German labels out!

@flavens flavens merged commit 12d0edc into main Jul 19, 2022
13 checks passed
@flavens flavens deleted the wip/dev-1049-update-user-guide branch Jul 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants