Change CircleCI job title to "Rendered docs" #21423
Conversation
|
This is on purpose so that it's obvious to find in the list of checks. |
|
On one hand the call to action is nice, on the other hand I see the argument for consistency. I think either is fine. |
|
If standing out is the goal, something like |
|
I liked "Check Rendered Docs" cause the other goal was making this all as obvious as possible to new contributors. While "rendered docs" is pretty obvious, the check is nice as the explicit this is what you do here. |
|
I'm in favour of the "Check the rendered docs here!" too. |
|
If we are wordsmithibg I would go for "check the built docs". "To render" is a pretty technical term in this context whereas "to build" is pretty straightforward. But I also agree that keeping "check" in here is useful for those who are just getting started. Whereas the tests either pass or fail, it is often necessary to check the built docs to make sure they look right. Making it clear where to find them is helpful. |
This was "Check the rendered docs here!" before. None of the other job names is a full sentence.
51f7fc7 to
5e7ea73
Compare
|
Mixing everything together, I ended with "View the built docs". 😄
|
| @@ -10,4 +10,4 @@ jobs: | |||
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |||
| artifact-path: 0/doc/build/html/index.html | |||
| circleci-jobs: docs-python38 | |||
| job-title: Check the rendered docs here! | |||
| job-title: View the built docs | |||
There was a problem hiding this comment.
| job-title: View the built docs | |
| job-title: View the built docs! |
feel like the ! is what makes it really stand out, but like this wording either way.
There was a problem hiding this comment.
The ! was actually what made me stuble. I find the exclamation mark too strong and a bit offensive here. Viewing the docs is only an offer, not a mandatory or important call to action.
There was a problem hiding this comment.
I think that may be cultural, as I think @story645 maybe meant it in the "have fun!" sort of way. However, even in that sense its a bit informal, and I don't think it helps get the point across, so lets merge this as-is!
There was a problem hiding this comment.
Yeah I read/intended the exclamation as a "hey, you can view the docs here!" but totally see how that's a cultural thing so am fine w/ no !
This was "Check the rendered docs here!" before. None of the other
job names is a full sentence.