wwt / SwiftCurrent

A library for managing complex workflows in Swift
https://wwt.github.io/SwiftCurrent/
Apache License 2.0
308 stars 19 forks source link

Updates README.md to be more compelling #24

Closed Richard-Gist closed 3 years ago

Richard-Gist commented 3 years ago

Linked Issue:

Checklist:


If Applicable:


If Public API Has Changed:

cla-bot[bot] commented 3 years ago

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Megan Wiemer. This is most likely caused by a git client misconfiguration; please make sure to:

  1. check if your git client is configured with an email to sign commits git config --list | grep email
  2. If not, set it up using git config --global user.email email@example.com
  3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
sonarcloud[bot] commented 3 years ago

Kudos, SonarCloud 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

Richard-Gist commented 3 years ago

EOD: Brought in Wiki files to source so that we can codify the changes. We also improved our tone and voice to be better on brand (more to go).

Richard-Gist commented 3 years ago

EOD: Decided that the original direction of Getting-Started was more suited as a Tutorial and a more slimmed down, succinct version should be used instead.

Richard-Gist commented 3 years ago

Just dropping a note here to run Jazzy again so that it has the updated README for its documentation.

Tyler-Keith-Thompson commented 3 years ago

@Tyler-Keith-Thompson How do you feel about turning these references to Workflow into links to the documentation for Workflow? I'm on the fence since these aren't all specifically calling out the type Workflow, but they are all formatted as code.

I was uncertain at the time myself. I don't have any issues with it per se but this feels like documentation that would be easily overlooked if we changed the name/link

Richard-Gist commented 3 years ago

Someone please create a Change Request to generate Jazzy documentation so we don't forget. I don't want to do it now because it obscures the important changes we made.

EOD: We rechecked our tone compared to what WWT expects in our branding, and revised Installation to match that voice. We want to help people find the information needed to get started with our project, but we believe other resources will do a better job than this Github page.

sonarcloud[bot] commented 3 years ago

Kudos, SonarCloud 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