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

Docs: Alerting Notifications - make last three sections show on online docs #23587

Merged
merged 1 commit into from
Apr 15, 2020
Merged

Conversation

jmidgren
Copy link
Contributor

What this PR does / why we need it:

The last three sections of this document are not rendered on grafana.com/docs. It seems like in all other instances (other .md docs of this project), level one headers are only used at the top of the page, so I assume using level two headers will make them show. Level two headers do also match the overall structure of the documentation.

Which issue(s) this PR fixes:

Fixes #23584

Special notes for your reviewer:

The last three sections of this document are not rendered on https://grafana.com/docs/grafana/latest/alerting/notifications 
It seems like in all other instances (other .md docs of this project), level one headers are only used at the top of the page, so I assume using level two headers will make them show. Level two headers do also match the overall structure of the documentation.
@jmidgren jmidgren requested a review from oddlittlebird as a code owner April 15, 2020 12:11
@CLAassistant
Copy link

CLAassistant commented Apr 15, 2020

CLA assistant check)
All committers have signed the CLA.

@jmidgren
Copy link
Contributor Author

So, I have not actually checked that my change fixes the issue reported since I don't know how to do that. Nonetheless the document structure seem to imply that these headers should be level two so the pull request should still be valid 😃

@bergquist
Copy link
Contributor

If you want to test it out there is a short guide for how you can start the docs site locally using docker
https://github.com/grafana/grafana/tree/master/docs#build-the-doc-site

Copy link
Contributor

@oddlittlebird oddlittlebird left a comment

Choose a reason for hiding this comment

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

Great check! Thanks for contributing to the docs!

@oddlittlebird oddlittlebird merged commit 4c80eb7 into grafana:master Apr 15, 2020
@jmidgren jmidgren deleted the patch-1 branch April 16, 2020 06:36
@aknuds1 aknuds1 added pr/external This PR is from external contributor type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project labels Apr 16, 2020
bergquist added a commit that referenced this pull request Apr 17, 2020
* master: (139 commits)
  SAML Role and Team sync (open source part) (#23391)
  Transformers: fixes column names generated by seriesToColumn transformer (#23642)
  Table: add a select option when multiple tables exist (#23545)
  Tabs: adds counter component (#23548)
  UX: Minor style tweaks and fixes (#23614)
  Modals: Fixed alignment in header (#23618)
  revent optional event arg change (#23622)
  Build: Stricter linting should break the build (#23606)
  Docs: update users API (#23570)
  Explore: Prevents sizing issue when split (#23596)
  @grafana/ui: Various smaller Icon updates (#23588)
  Because alpine uses musl instead of libc, the e2e/cypress was not compatible (#23602)
  Backend Plugins: Discard logged messages from logger named stdio (#23601)
  Fixed share json (#23607)
  Linting fixes for provisoning (#23600)
  Image Rendering: Remove PhantomJS support (#23460)
  Storybook: Organizing (#23572)
  @grafana/ui: Remove ColorPallete component (#23592)
  Docs: Change header levels of last three sections (#23587)
  CircleCI: Upgrade the build pipeline tool (#23595)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/external This PR is from external contributor type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs feedback: /alerting/notifications.md
5 participants