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
Update upgrading-to-the-github-customer-agreement.md #30802
base: main
Are you sure you want to change the base?
Conversation
Add links (in "Further Reading") to "Standard Terms" and "Customer Terms", as they are mentioned in the first paragraph of the text, while only the "Corporate Terms" (deprecated and seemingly not as important here) were linked to. Someone may want to incorporate the links within the text as well/instead, but I realize that may not be desirable for some reason so did not propose that here.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
|
Ah, ok. So only AFTER submitting the PR do we see the "view deployment" option. That's a bit confusing (to have to agree to having done it before it's possible.) Anyway, I see now that there IS one problem--in that I had used the "autotitle" feature but it's not working for one of the two links I added. And I won't be able to edit this file whose commit I've offered (at least in the Github web UI for proposing doc changes, it doesn't seem possible.) But lest someone close this due to that failure, I'll point out that the title for the page in question is, "Customer Terms", so if a maintainer seeing this wanted to slip in that change after/while accepting mine, that would resolve things. Clearly, I'm not a pro-level github user--and I'm only using this web UI vs rebuilding the docs locally. I hope you can tell I'm simply trying to help improve the docs, as I am in fact reading them to better understand things. :-) |
This comment was marked as spam.
This comment was marked as spam.
|
@carehart Thanks so much for opening a PR, and the thorough explanation on your thoughts process 💛 I'll get this triaged for review ✨ |
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.
I've made a suggestion which should fix the broken link—I'll explain why in a separate comment
| @@ -27,4 +27,6 @@ You can upgrade to the {% data variables.product.company_short %} Customer Agree | |||
|
|
|||
| ## Further reading | |||
|
|
|||
| - "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service)" | |||
| - "[AUTOTITLE](https://github.com/customer-terms)." | |||
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.
| - "[AUTOTITLE](https://github.com/customer-terms)." | |
| - The [GitHub Customer Terms](https://github.com/customer-terms) |
|
@carehart Thank you for raising a PR! I agree with the change you recommend here, in terms of customer experience. A few things to note. I'll reply in-line to your comments:
Apologies this wasn't clear—you might find this page useful https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs#reviewing-your-own-pull-requests. I'll discuss internally whether there's anything more we can do to make that experience better for users here. Another option (in future) would be to run the documentation locally, so that you can see changes you make in a local preview instance, without needing to submit a PR first.
You were quite right to use AUTOTITLE; the only problem was that that feature only works with
I've made a "suggestion" that you can apply. I agree the Web UI is a little limited in this respect in terms of making further changes to an already submitted PR. For future reference: you should also have been able to make a "suggestion" yourself, even if that's a little bit awkward, so I've included the docs page describing that feature in an in-line link at the start of this paragraph for your reference. In any case, once we've resolved the outstanding point, I'll be happy to get this merged 😄 |
Add links (in "Further Reading") to "Standard Terms" and "Customer Terms".
Why:
They are mentioned in the first paragraph of the text, while only the "Corporate Terms" (deprecated and seemingly not as important here) were linked to.
Someone may want to incorporate the links within the text as well/instead, but I realize that may not be desirable for some reason so did not propose that here.
What's being changed (if available, include any code snippets, screenshots, or gifs):
Just adding two links.
Check off the following:
(I could not find this "view deployment" feature "in this PR's timeline". I'm submitting this change via the github web UI. Since I'm following the pattern of a line already there, I'm going to ASSUME it would render ok. I confirmed my NEW links worked the same as the existing link whose pattern I used. )
datadirectory.