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

[DOC] Replace note rST block for GitHub #46214

Merged
merged 1 commit into from Feb 27, 2018
Merged

[DOC] Replace note rST block for GitHub #46214

merged 1 commit into from Feb 27, 2018

Conversation

vutny
Copy link
Contributor

@vutny vutny commented Feb 27, 2018

What does this PR do?

This PR removes note rST block in favor of just bold heading text in example of README file at formulas doc page.
It seems neither GitHub, nor Bitbucket does not properly support it and the rendered text does not look expressive. Same thing was done previously in saltstack/salt-bootstrap repository.

Commits signed with GPG?

Yes

@rallytime
Copy link
Contributor

@vutny I don't think we want to change that here because the file is an .rst file and we use that .. note syntax in our doc builds.

I changed it in the salt-bootstrap file because we don't actually build those docs anywhere to use the rst syntax.

@vutny
Copy link
Contributor Author

vutny commented Feb 27, 2018

@rallytime I think you'd not build that particular README file since it is embedded in own

.. code-block:: restructuredtext

block. So it does not affect building properly formatted formulas page.

Copy link
Contributor

@rallytime rallytime left a comment

Choose a reason for hiding this comment

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

@vutny Ah, I see. You're right. Thanks!

@rallytime rallytime merged commit 7917277 into saltstack:2017.7 Feb 27, 2018
@vutny vutny deleted the formulas-readme-formatting branch March 5, 2018 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants