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

Add: clarify config relationship; fix headings. #4478

Merged
merged 5 commits into from Jun 26, 2020

Conversation

teesloane
Copy link
Contributor

Clarify the relationship between "step vs. job vs. workflow vs. pipeline". Research has found that these concepts are a little unclear to users.

In this PR:

  • Move the "configuration" section up in the document.
  • Some re-wording in the section under #configuration (although @rosieyohannan has done lots of great work on this document recently as well, especially the graphics).
  • Cleans up the table of contents to not be nested.

@KateCatlin is wondering if we can get some other designs that can better represent the relationship between steps/jobs/workflow/pipelines, but for now, hopefully this prose clears it up.

@rosieyohannan
Copy link
Contributor

Looks great! 🎉

Copy link
Contributor

@michelle-luna michelle-luna 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, just a few small suggestions, thank you!

jekyll/_cci2/concepts.md Outdated Show resolved Hide resolved
jekyll/_cci2/concepts.md Outdated Show resolved Hide resolved
jekyll/_cci2/concepts.md Outdated Show resolved Hide resolved
jekyll/_cci2/concepts.md Outdated Show resolved Hide resolved
teesloane and others added 4 commits June 26, 2020 14:48
Co-authored-by: Michelle <michellelunastar@gmail.com>
Co-authored-by: Michelle <michellelunastar@gmail.com>
Co-authored-by: Michelle <michellelunastar@gmail.com>
Co-authored-by: Michelle <michellelunastar@gmail.com>
@teesloane
Copy link
Contributor Author

Thanks @michelle-luna !

@michelle-luna michelle-luna merged commit 612d398 into master Jun 26, 2020
@michelle-luna michelle-luna deleted the tjs/concepts-update branch June 26, 2020 19:09
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

3 participants