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

Render the example helpful tip properly. #1586

Merged
merged 2 commits into from
Aug 24, 2020
Merged

Render the example helpful tip properly. #1586

merged 2 commits into from
Aug 24, 2020

Conversation

rosiel
Copy link
Member

@rosiel rosiel commented Aug 20, 2020

Purpose / why

There was an example of the syntax to create a "Helpful tip" - it was wrong, and on github.io it wasn't rendering.

What changes were made?

Put the text of the tip on a newline indented four spaces, also provided a link to the "Admonition" extension where this behaviour is documented.

Verification

You'll have to mkdocs serve to see if it renders locally.

Interested Parties

@manez


Checklist

Pull-request reviewer should ensure the following

Person merging should ensure the following

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

@manez
Copy link
Member

manez commented Aug 21, 2020

Something is still going sideways for me when I test this. The tooltip renders fine, but the text is showing up outside of it. Comparing it to examples in the docs where the tooltip is working, I cannot figure out the difference:

image

docs/contributing/docs_style_guide.md Outdated Show resolved Hide resolved
docs/contributing/docs_style_guide.md Outdated Show resolved Hide resolved
Copy link
Member

@manez manez left a comment

Choose a reason for hiding this comment

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

tested again, and it's all rendering properly

Copy link
Member

@whikloj whikloj left a comment

Choose a reason for hiding this comment

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

Looks good!

@whikloj whikloj merged commit fbdbda5 into master Aug 24, 2020
@whikloj whikloj deleted the rosiel-patch-2 branch August 24, 2020 14:10
rosiel added a commit to rosiel/documentation that referenced this pull request Sep 9, 2020
* Render the example helpful tip properly.

* Fix note syntax, again.
jordandukart pushed a commit that referenced this pull request Sep 9, 2020
* Render the example helpful tip properly. (#1586)

* Render the example helpful tip properly.

* Fix note syntax, again.

* Update rdf-mapping.md doc (#1585)

Co-authored-by: Eli Zoller <5439169+elizoller@users.noreply.github.com>
dannylamb pushed a commit that referenced this pull request Sep 11, 2020
* Render the example helpful tip properly. (#1586)

* Render the example helpful tip properly.

* Fix note syntax, again.

* Update rdf-mapping.md doc (#1585)

Co-authored-by: Eli Zoller <5439169+elizoller@users.noreply.github.com>
dannylamb added a commit that referenced this pull request Sep 16, 2020
…1598)

* Render the example helpful tip properly. (#1586)

* Render the example helpful tip properly.

* Fix note syntax, again.

* Mention the User Call (#1587)

* Update rdf-mapping.md doc (#1585)

* Update committers.md (#1592)

* Document using base box and dev branch

Co-authored-by: Eli Zoller <5439169+elizoller@users.noreply.github.com>
Co-authored-by: dannylamb <dlamb@islandora.ca>
whikloj pushed a commit that referenced this pull request Sep 30, 2020
* Render the example helpful tip properly. (#1586)

* Render the example helpful tip properly.

* Fix note syntax, again.

* Mention the User Call (#1587)

* Update rdf-mapping.md doc (#1585)

* Update committers.md (#1592)

* Fix committer nomination email address (#1593)

* Fix old email address.

* Update closeCommitterVote.txt

* De-CLAW

* De-CLAW

* DeCLAW

* Change email

* De-CLAW

* Update travis for the main branch switch (#1594)

* Master -> Main Rename

* Remove comments about WebAC (#1555)

* Remove comments about WebAC

WebAC is not used but is listed as a feature added when using Fedora. Although it is there, I'd suggest leaving off of this documentation.

* Update user-intro.md

* Add more details about starting up an islandora. (#1597)

* Add more details about starting up an islandora.

* Update index.md

* Mention use of dev branch for prebuilt base box

* Update index.md

* Fix typo in VBE

* Make clearer the different levels of sandbox reqs.

* Update CONTRIBUTING.md (#1601)

* Add Jordan to committers list (#1602)

* Migration docs updates (#1603)

* Added link to newer migration Youtube vid, added migration-overview.md

* Replaced used of "*" with "-" for bulleted lists

* Updated headings in docs and spelling changes

* Main update (#1612)

* Render the example helpful tip properly. (#1586)

* Render the example helpful tip properly.

* Fix note syntax, again.

* Update rdf-mapping.md doc (#1585)

Co-authored-by: Eli Zoller <5439169+elizoller@users.noreply.github.com>

* Merge changes to add @manez to committers. (#1613)

* Merge changes to add @manez to committers.

* Alphabeticalize committer names.

Co-authored-by: dannylamb <dlamb@islandora.ca>

* De-CLAWing

* Derp

* Missing parenthesis

Co-authored-by: Rosie Le Faive <lefaive@gmail.com>
Co-authored-by: Eli Zoller <5439169+elizoller@users.noreply.github.com>
Co-authored-by: Jonathan Green <jonathan.green@lyrasis.org>
Co-authored-by: Don Richards <DonRichards@utk.edu>
Co-authored-by: Melissa Anez <manez@islandora.ca>
Co-authored-by: Yamil <ysuarez@users.noreply.github.com>
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.

3 participants