Skip to content

Change CircleCI job title to "Rendered docs" #21423

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.

Sign up for GitHub

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

Merged
jklymak merged 1 commit into from
Oct 25, 2021
Merged

Change CircleCI job title to "Rendered docs" #21423

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/circleci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

@story645 story645 Oct 25, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
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.

@timhoffm timhoffm Oct 25, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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.

@jklymak jklymak Oct 25, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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!

@story645 story645 Oct 25, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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 !