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

Put the preview notice at the top of the subsection instead of at the bottom #980

Closed
gijswijs opened this issue Nov 2, 2020 · 2 comments
Labels
ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team

Comments

@gijswijs
Copy link
Contributor

gijswijs commented Nov 2, 2020

What is the current behavior?

The preview notice is shown at the bottom of a subsection. This makes it very easy to overlook. (e.g: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#create-a-repository-using-a-template)

image

What changes are you suggesting?

I suggest putting the preview notice on top of the subsection directly below the heading. This was also the behavior in the old documentation. See: https://developer.github.com/v3/repos/#create-a-repository-using-a-template

image

@gijswijs gijswijs added the engineering Will involve Docs Engineering label Nov 2, 2020
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 2, 2020
@runleonarun
Copy link
Contributor

Hey @gijswijs Thank you for raising this issue! I agree that the preview note could use better visibility. We will look at this problem holistically and consider some different ideas including moving the note.

@chiedo chiedo removed the engineering Will involve Docs Engineering label Nov 30, 2020
@chiedo chiedo added ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team and removed triage Do not begin working on this issue until triaged by the team labels Jan 13, 2021
@janiceilene
Copy link
Contributor

We're looking at this internally since it would be such an overarching change!

jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this issue Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team
Projects
None yet
Development

No branches or pull requests

4 participants