Skip to content

Comments

Feature/35 write first tutorials - first cleanup#45

Merged
sdruskat merged 39 commits intodevelopfrom
feature/35-write-first-tutorials
Jan 18, 2023
Merged

Feature/35 write first tutorials - first cleanup#45
sdruskat merged 39 commits intodevelopfrom
feature/35-write-first-tutorials

Conversation

@led02
Copy link
Member

@led02 led02 commented Sep 23, 2022 •
edited by poikilotherm
Loading

  • Read through the tutorials and check for orthography and grammar and stuff.
  • Test all the tutorial steps with 26 implement processing step #40 branch.
  • Add suggestions for clarification / extensions.
  • Propose next tutorials.

Relates to #35
Closes #103

@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 13, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@poikilotherm poikilotherm self-assigned this Jan 12, 2023
@poikilotherm poikilotherm force-pushed the feature/35-write-first-tutorials branch from 1f799be to 6631dc9 Compare January 12, 2023 13:02
@poikilotherm poikilotherm changed the title Feature/35 write first tutorials Feature/35 write first tutorials - first cleanup Jan 12, 2023
@poikilotherm
Copy link
Member

poikilotherm commented Jan 12, 2023

After discussion, this PR is now scoped only to be a first good cleanup and implements a tutorial for starting development.

It will no longer close #35, but relates to it. The tutorial for enabling a repo with HERMES is still to be done!

@poikilotherm poikilotherm marked this pull request as ready for review January 12, 2023 16:04
@poikilotherm poikilotherm requested a review from sdruskat January 12, 2023 16:04
@poikilotherm poikilotherm mentioned this pull request Jan 12, 2023
Merged
sdruskat
sdruskat requested changes Jan 13, 2023
View reviewed changes
Copy link
Contributor

@sdruskat sdruskat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @poikilotherm for the overhaul 🌮!

While a lot of it is good to go IMHO, I'm requesting changes, mostly to avoid unmaintainable sections, remove promises, duplications, and tech bias.

poikilotherm and others added 2 commits January 16, 2023 08:19
@poikilotherm @sdruskat
doc: apply suggestions from code review
ae6b248 
Co-authored-by: Stephan Druskat <sdruskat@users.noreply.github.com>
@poikilotherm
doc: fix license of opengraph image to CC-BY-ND as it contains the ke…
bc5ec73 
…y visual
@poikilotherm poikilotherm force-pushed the feature/35-write-first-tutorials branch from 3479b9c to 2b34d57 Compare January 16, 2023 08:33
@poikilotherm
Copy link
Member

poikilotherm commented Jan 16, 2023 •
edited
Loading

Alright @sdruskat all review comments done. Can you take another look?

Please note: to not leave the docs start page completely chaotic, I added a few introduction sentences, stitched together from diverse abstracts etc and added the birds-eye view diagram.

I also switched the header graphics again to simply reuse the template the paid for and make the filesize even smaller.
A matching color palellete has been generated and used on the birdseye view diagram.

Rendered version here: https://hermes-workflow--45.org.readthedocs.build/en/45/

@poikilotherm poikilotherm requested a review from sdruskat January 16, 2023 14:00
@sdruskat sdruskat mentioned this pull request Jan 18, 2023
Open
@sdruskat sdruskat mentioned this pull request Jan 18, 2023
Merged
poikilotherm
poikilotherm approved these changes Jan 18, 2023
View reviewed changes
Copy link
Member

@poikilotherm poikilotherm left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All set, LGTM. Merge merge merge!

@sdruskat can you please approve so we can merge? Thx!

sdruskat
sdruskat approved these changes Jan 18, 2023
View reviewed changes
Copy link
Contributor

@sdruskat sdruskat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now.

@sdruskat sdruskat merged commit 0cb7f29 into develop Jan 18, 2023
@sdruskat sdruskat deleted the feature/35-write-first-tutorials branch January 18, 2023 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sdruskat sdruskat sdruskat approved these changes

@poikilotherm poikilotherm poikilotherm approved these changes

Assignees

@poikilotherm poikilotherm

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Link contribution guidelines from documentation

3 participants

@led02 @poikilotherm @sdruskat