Skip to content

Use :guilabel: sphinx role for all the Admin menu guideance #5137

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

Closed
humitos opened this issue Jan 21, 2019 · 12 comments
Closed

Use :guilabel: sphinx role for all the Admin menu guideance #5137

humitos opened this issue Jan 21, 2019 · 12 comments
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Needed: documentation Documentation is required

Comments

@humitos
Copy link
Member

humitos commented Jan 21, 2019

I think this is the best way to render all the Admin menu instructions for the user and we should use it all across our documentation:

:guilabel:`Domains` > :guilabel:`Edit Domain`

Example: https://docs.readthedocs.io/en/latest/custom_domains.html#custom-domain-ssl

I found that many places use bold for this, but this approach of :guilabel: is better.

@humitos humitos added the Needed: documentation Documentation is required label Jan 21, 2019
@humitos humitos added this to the Better user documentation milestone Jan 21, 2019
@humitos humitos added Good First Issue Good for new contributors Accepted Accepted issue on our roadmap labels Jan 21, 2019
@csranasinghe
Copy link
Contributor

I am a first time contributor to this project. I like to work on this one. I just cloned the project. Any tips to start?

@dojutsu-user
Copy link
Member

@rexzing
You can start by reading the contribution guide: https://docs.readthedocs.io/en/latest/contribute.html
Welcome to the community.

@csranasinghe
Copy link
Contributor

I folowed the guide and now I have a u and running server. Where should I look for " Admin menu instructions"? Any example file?

@dojutsu-user
Copy link
Member

Files for the docs are under the docs folder (readthedocs.org/docs/).
Example is provided in the issue description.
Here are the docs for contributing to the docs: https://docs.readthedocs.io/en/latest/docs.html

@csranasinghe
Copy link
Contributor

screenshot from 2019-01-23 14-43-47
In here should I add :guilabel: to "New Email Notifications" and "Email" ?

@dojutsu-user
Copy link
Member

I guess, yes.
You can make a PR, the team will review it there.

csranasinghe added a commit to csranasinghe/readthedocs.org that referenced this issue Jan 23, 2019
@csranasinghe
Copy link
Contributor

I finished the task. Shall I PR to master?

@dojutsu-user
Copy link
Member

Please make a separate branch in your forked repo and then make a PR.

@csranasinghe
Copy link
Contributor

Oh.. I just submit a PR. What should I do now?

@dojutsu-user
Copy link
Member

@rexzing
I would suggest the following steps:

  1. Close this PR.
  2. In your forked repo, create a new branch.
  3. Make changes.
  4. Add and commit changes.
  5. Make the PR from that branch with correct PR title and description.

@csranasinghe
Copy link
Contributor

I think this issue is fixed and ready to close.

@stsewd
Copy link
Member

stsewd commented Feb 18, 2019

Yes, thanks

@stsewd stsewd closed this as completed Feb 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

4 participants