-
Notifications
You must be signed in to change notification settings - Fork 370
Conversation
I meant to make this a draft pull request. I still have a few updates I would like to make. |
91b349e
to
7937dc3
Compare
This is ready for review. |
7937dc3
to
aaad3ae
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an impressive rewrite; thank you for it!
There are a few things inline that I think need adjustments. There are also two structural things that need a bit more iteration:
Sections
The name of the "Configuration" section makes sense. But the "Workflows" section is confusing, because it collides with the local term of art, where in GitHub Actions a "workflow" is a YAML file that sets up a chain of actions. Consequently, the "Workflows" section doesn't contain what I'd expect it to, after reading the front page and the main configuration page:
In a different context, I could get down with "workflows" being the correct name for what we're dealing with here, but locally I think we have to call it something different. Spitballing here:
- How-To
- Customization
- Common Tasks
...but I'm open to other suggestions.
If you don't want to wrestle with this one alone, we can jam about it in the #proj-tf-docs channel or something.
Redirects
This changes a bunch of URLs! Before we ship it, we've gotta get the appropriate redirects into content/redirects.txt
.
That should probably wait until we sort out what to do about the workflows
directory.
fc96bfe
to
1197118
Compare
Updated with changes based on your feedback. I went with the name "Common Actions" instead of "Workflows". I'm open to changing it if needed. I also updated |
The TravisCI build is complaining about missing links.
Seems like these links are now located at the following places respectively.
|
Looking into those azure things right now, I think I found the issue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For any spectators: we caught up in Slack and are gonna change it to "Common Tasks."
Here's one or two more small items I noticed — ping me once you're done, and I'll do a last check to make sure all the links line up, and then we can
content/source/docs/github-actions/common-actions/arguments.html.md
Outdated
Show resolved
Hide resolved
content/source/docs/github-actions/common-actions/working-directory.html.md
Outdated
Show resolved
Hide resolved
content/source/docs/github-actions/common-actions/index.html.md
Outdated
Show resolved
Hide resolved
content/source/docs/github-actions/common-actions/index.html.md
Outdated
Show resolved
Hide resolved
content/source/docs/github-actions/common-actions/index.html.md
Outdated
Show resolved
Hide resolved
bb7c830
to
477dc30
Compare
Updated to reflect YAML syntax Reorganized content layout
Fixing links to adhere to layout changes.
Renamed Common Actions to Common tasks and removed `sidebar_current` from front matter within the Markdown files.
477dc30
to
101fc0e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks again for all your work on this! Tweaked the thing about outputs to reference user-level docs, and added an example. And with that, I think we're done.
Updated to reflect YAML syntax
Reorganized content layout