Skip to content

Conversation

@arolfes
Copy link
Contributor

@arolfes arolfes commented Apr 1, 2023

Only readme and images therefore no sonarcloud.

The diff of the readme is very large. You can find a rendered version here: https://github.com/arolfes/taskana/blob/2148-readme/README.md


Release Notes:


For the submitter:

Verified by the reviewer:

  • Commit message format → TSK-XXX: Your commit message.
  • Submitter's update to documentation is sufficient
  • SonarCloud analysis meets our standards
  • Update of the current release notes reflects changes
  • PR fulfills the ticket
  • Edge cases and unwanted side effects are tested
  • Readability

@arolfes arolfes added this to the v6.0.3 milestone Apr 1, 2023
@arolfes arolfes force-pushed the 2148-readme branch 3 times, most recently from a554b81 to 0d0abf5 Compare April 2, 2023 10:55
@arolfes arolfes linked an issue Apr 2, 2023 that may be closed by this pull request
@arolfes arolfes marked this pull request as ready for review April 2, 2023 10:56
@arolfes arolfes force-pushed the 2148-readme branch 3 times, most recently from c3073a5 to 61cffed Compare April 2, 2023 13:27
@arolfes arolfes removed this from the v6.0.3 milestone Apr 12, 2023
@ryzheboka
Copy link
Contributor

The README in this PR looks way better than before!

What is the rule for spelling entities? In this PR, some entities are spelled in caps (e. g. WORKBASKET). Some other entities are lowercase (e. g. workbasket) or uppercase (e. g. Workbasket).

How should TASKANA be spelled? As "Taskana" or "TASKANA"?

Are the spelling questions relevant, or are the incosistencies ok?

@ryzheboka
Copy link
Contributor

Hi @arolfes , this PR looks really helpful to me. What needs to be done before integrating it?

@arolfes
Copy link
Contributor Author

arolfes commented Oct 26, 2023

Hallo @ryzheboka ,

What needs to be done before integrating it?

The review is missing. Can you do a review? When you approve the changes, you can merge it or I will.

This image is not up to date because of two new TaskStatus "IN_REVIEW" and "READY_FOR_REVIEW". What do you think about the attached image instead?

By the way: I took your Image. :)

Best regards
Alex

@arolfes
Copy link
Contributor Author

arolfes commented Oct 26, 2023

Hello @ryzheboka

How should TASKANA be spelled? As "Taskana" or "TASKANA"?

You are absolutely right, TASKANA should always be capitalised as a name in the documentation.

@arolfes
Copy link
Contributor Author

arolfes commented Oct 26, 2023

Hello @ryzheboka

What is the rule for spelling entities? In this PR, some entities are spelled in caps (e. g. WORKBASKET). Some other entities are lowercase (e. g. workbasket) or uppercase (e. g. Workbasket).

Are the spelling questions relevant, or are the incosistencies ok?

Can you talk to Holger about it? I know in which case you write everything in capital letters and in which case in small letters.

If he thinks it's OK, then we leave it as it is and merge the thing.

I believe that anyone who stumbles across an inconsistency can fix it.

@ryzheboka
Copy link
Contributor

ryzheboka commented Oct 31, 2023

Hi @arolfes ,

I asked @holgerhagen about uppercase vs lovercase. He said that we agreed to start every entity in uppercase. In the following example, "task" and "tasks" need to start in uppercase:
"Workbaskets indicate the responsibility for a task. The concepts of Workbaskets allow to differentiate between the permissions or the skills required to complete a tasks and the determination who should complete the tasks. This can diverge a lot in a larger organization."

Could you adjust this? Alternatively, I could add a commit to this branch that adjusts it.

@arolfes
Copy link
Contributor Author

arolfes commented Oct 31, 2023

Could you adjust this? Alternatively, I could add a commit to this branch that adjusts it.

Hi @ryzheboka ,

It would be very helpful for me if you can do it. I trust you there. :) I gave you write permissions to this branch

I force pushed my branch. So you need do a git fetch && git pull first.

@ryzheboka
Copy link
Contributor

The branch is rebased. I also adjusted the capitalization. @arolfes, could you check if everything looks ok? Then we can integrate this PR

@arolfes
Copy link
Contributor Author

arolfes commented Nov 8, 2023

The branch is rebased. I also adjusted the capitalization. @arolfes, could you check if everything looks ok? Then we can integrate this PR

Good Morning,
for me everything looks ok.

I think we can merge it

@ryzheboka
Copy link
Contributor

Hi @arolfes,
@gitgoodjhe noticed that the images look strange in dark mode. What do you think about adding white background to the "task lifecycle" and "workbaskets" images? I could change this :)

grafik

@arolfes
Copy link
Contributor Author

arolfes commented Nov 10, 2023

Hello @ryzheboka ,

the images look strange in dark mode. What do you think about adding white background to the "task lifecycle" and "workbaskets" images?

I totally agree on this topic. the images look a bit strange :) White is fine. So it should work also in "normal" mode :)

I could change this :)
yes please. I'm not able to to such changes. Image manipulation is always a challenge for...

@ryzheboka ryzheboka merged commit 95057d6 into Taskana:master Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refactor README to make it more appealing

3 participants