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

Updates README.md to be more compelling #24

Merged
merged 34 commits into from May 27, 2021
Merged

Conversation

Richard-Gist
Copy link
Collaborator

Linked Issue:

Checklist:


If Applicable:

  • Did you test when the first item is skipped?
  • Did you test when the last item is skipped?
  • Did you test when middle items are skipped?
  • Did you test when incorrect data is passed forward?
  • Did you test proceeding backwards?

If Public API Has Changed:

  • Did you deprecate (rather than remove) any old methods/variables/etc? Our philosophy for deprecation.
  • Have you done the best that you can to make sure that the compiler guides people to changing to the new API? (Example: the renamed attribute)
  • If necessary, have you tested the upgrade path for at least N-1 versions? For example, if data persists between v1 and v2 then that upgrade should be tested and as easy as we can make it.

@Richard-Gist Richard-Gist added the documentation Improvements or additions to documentation label May 20, 2021
@cla-bot cla-bot bot added the cla-signed label May 20, 2021
@cla-bot
Copy link

cla-bot bot commented May 20, 2021

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

@cla-bot cla-bot bot removed the cla-signed label May 20, 2021
@sonarcloud
Copy link

sonarcloud bot commented May 20, 2021

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

@cla-bot cla-bot bot added the cla-signed label May 20, 2021
@Richard-Gist
Copy link
Collaborator Author

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
Copy link
Collaborator Author

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 Richard-Gist self-assigned this May 24, 2021
@Richard-Gist
Copy link
Collaborator Author

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

…d marked remaining section of the page that needs more love - RAG BL
… do not interrupt scrolling through the high level docs - RAG BL
@Tyler-Keith-Thompson
Copy link
Collaborator

@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 Richard-Gist marked this pull request as ready for review May 26, 2021 23:56
@Richard-Gist
Copy link
Collaborator Author

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.

@Richard-Gist Richard-Gist added this to In progress (3) in SwiftCurrent Kanban May 27, 2021
@Richard-Gist Richard-Gist moved this from In progress (3) to Review (2) in SwiftCurrent Kanban May 27, 2021
Copy link
Contributor

@wiemerm wiemerm left a comment

Choose a reason for hiding this comment

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

The commented out gif to be added either make a card or finish it in this. The rest to be fixed.

README.md Outdated Show resolved Hide resolved
STYLEGUIDE.md Outdated Show resolved Hide resolved
wiki/Getting-Started.md Show resolved Hide resolved
wiki/Getting-Started.md Outdated Show resolved Hide resolved
wiki/Getting-Started.md Outdated Show resolved Hide resolved
wiki/Installation.md Show resolved Hide resolved
wiki/Why-This-Library.md Outdated Show resolved Hide resolved
wiki/Why-This-Library.md Outdated Show resolved Hide resolved
wiki/Why-This-Library.md Outdated Show resolved Hide resolved
Copy link
Contributor

@wiemerm wiemerm left a comment

Choose a reason for hiding this comment

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

Do the thing it says.

README.md Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented May 27, 2021

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

@brianlombardo brianlombardo changed the title [documentation-updates] - Updating README.md to be more compelling - MOB Updates README.md to be more compelling May 27, 2021
@brianlombardo brianlombardo merged commit 8733a5a into main May 27, 2021
@brianlombardo brianlombardo deleted the documentation-updates branch May 27, 2021 18:54
@Richard-Gist Richard-Gist moved this from Review (2) to Ready for Demo in SwiftCurrent Kanban May 27, 2021
@Richard-Gist Richard-Gist moved this from Ready for Demo to Done in SwiftCurrent Kanban Jun 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants