Skip to content

Commit 4d3067e

Browse files
Docs: Refactor inconsistent unordered lists (grafana#27826)
* Docs: Refactor inconsistent unordered lists * add requested changes * Update docs/sources/linking/data-link-variables.md Co-authored-by: Diana Payton <[email protected]> * Update docs/sources/http_api/_index.md Co-authored-by: Diana Payton <[email protected]> * Update docs/sources/guides/whats-new-in-v6-0.md Co-authored-by: Diana Payton <[email protected]> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <[email protected]> * resolve weird line breaks * revert unintentional change * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <[email protected]> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <[email protected]> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <[email protected]> Co-authored-by: Diana Payton <[email protected]>
1 parent 7d7e727 commit 4d3067e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+737
-747
lines changed

.github/ISSUE_TEMPLATE/1-bug_report.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Please use this template to create your bug report. By providing as much info as
99
1010
PROTIP: record your screen and attach it as a gif to showcase the issue.
1111
12-
* Questions should be posted to: https://community.grafana.com
13-
* Use query inspector to troubleshoot issues: https://bit.ly/2XNF6YS
14-
* How to record and attach gif: https://bit.ly/2Mi8T6K
12+
- Questions should be posted to: https://community.grafana.com
13+
- Use query inspector to troubleshoot issues: https://bit.ly/2XNF6YS
14+
- How to record and attach gif: https://bit.ly/2Mi8T6K
1515
-->
1616

1717
**What happened**:

.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Thank you for sending a pull request! Here are some tips:
2222

2323
<!--
2424
25-
* Automatically closes linked issue when the Pull Request is merged.
25+
- Automatically closes linked issue when the Pull Request is merged.
2626
2727
Usage: "Fixes #<issue number>", or "Fixes (paste link of issue)"
2828

CHANGELOG.md

+257-257
Large diffs are not rendered by default.

CODE_OF_CONDUCT.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
88

99
Examples of behavior that contributes to creating a positive environment include:
1010

11-
* Using welcoming and inclusive language
12-
* Being respectful of differing viewpoints and experiences
13-
* Gracefully accepting constructive criticism
14-
* Focusing on what is best for the community
15-
* Showing empathy towards other community members
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
1616

1717
Examples of unacceptable behavior by participants include:
1818

19-
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20-
* Trolling, insulting/derogatory comments, and personal or political attacks
21-
* Public or private harassment
22-
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23-
* Other conduct which could reasonably be considered inappropriate in a professional setting
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
2424

2525
## Our Responsibilities
2626

ISSUE_TRIAGE.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ The core maintainers of the Grafana project are responsible for categorizing all
88

99
Triage helps ensure issues resolve quickly by:
1010

11-
* Ensuring the issue's intent and purpose is conveyed precisely. This is necessary because it can be difficult for an issue to explain how an end user experiences a problem and what actions they took.
12-
* Giving a contributor the information they need before they commit to resolving an issue.
13-
* Lowering the issue count by preventing duplicate issues.
14-
* Streamlining the development process by preventing duplicate discussions.
11+
- Ensuring the issue's intent and purpose is conveyed precisely. This is necessary because it can be difficult for an issue to explain how an end user experiences a problem and what actions they took.
12+
- Giving a contributor the information they need before they commit to resolving an issue.
13+
- Lowering the issue count by preventing duplicate issues.
14+
- Streamlining the development process by preventing duplicate discussions.
1515

1616
If you don't have the knowledge or time to code, consider helping with triage. The community will thank you for saving them time by spending some of yours.
1717

@@ -112,9 +112,9 @@ In general, if the issue description and title is perceived as a question no mor
112112

113113
To make it easier for everyone to understand and find issues they're searching for it's suggested as a general rule of thumbs to:
114114

115-
* Make sure that issue titles are named to explain the subject of the issue, has a correct spelling and doesn't include irrelevant information and/or sensitive information.
116-
* Make sure that issue descriptions doesn't include irrelevant information, information from template that haven't been filled out and/or sensitive information.
117-
* Do your best effort to change title and description or request suggested changes by adding a comment.
115+
- Make sure that issue titles are named to explain the subject of the issue, has a correct spelling and doesn't include irrelevant information and/or sensitive information.
116+
- Make sure that issue descriptions doesn't include irrelevant information, information from template that haven't been filled out and/or sensitive information.
117+
- Do your best effort to change title and description or request suggested changes by adding a comment.
118118

119119
> **Note:** Above rules is applicable to both new and existing issues of the Grafana project.
120120
@@ -335,6 +335,6 @@ This will give you a structure of labels in the sidebar similar to the following
335335
- Grafana
336336
```
337337

338-
* All notifications you’ll need to read/take action on show up as unread in GitHub (mine) and its sub-labels.
339-
* All other notifications you don’t need to take action on show up as unread in GitHub (other) and its sub-labels
340-
* This is convenient for issue triage and to follow the activity in the Grafana project.
338+
- All notifications you’ll need to read/take action on show up as unread in GitHub (mine) and its sub-labels.
339+
- All other notifications you don’t need to take action on show up as unread in GitHub (other) and its sub-labels
340+
- This is convenient for issue triage and to follow the activity in the Grafana project.

MAINTAINERS.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
@torkelo is the main/default maintainer, some parts of the codebase have other maintainers:
22

3-
* Backend:
4-
* @bergquist
5-
* Plugins:
6-
* @ryantxu
7-
* UX/UI:
8-
* @davkal
3+
- Backend:
4+
- @bergquist
5+
- Plugins:
6+
- @ryantxu
7+
- UX/UI:
8+
- @davkal

WORKFLOW.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,28 @@ Team members and their access to repositories is maintained through [GitHub team
1313
## Proposing changes
1414

1515
Examples of proposed changes are overarching architecture, component design, and specific code or graphical elements. Proposed changes SHOULD cover the big picture and intention, but individual parts SHOULD be split into the smallest possible changes. Changes SHOULD be based on and target the master branch. Depending on size of the proposed change, each change SHOULD be discussed, in increasing order of change size and complexity:
16-
* Directly in a RR (Pull Request) - this MAY be done, but SHOULD not be the common case.
17-
* Issue
18-
* Developer mailing list
19-
* Design document, shared via Google Docs, accessible to at least all team members.
16+
- Directly in a RR (Pull Request) - this MAY be done, but SHOULD not be the common case.
17+
- Issue
18+
- Developer mailing list
19+
- Design document, shared via Google Docs, accessible to at least all team members.
2020

2121
Significant changes MUST be discussed and agreed upon with the relevant subsystem maintainers.
2222

2323
## Merging PRs (Pull Requests)
2424

2525
Depending on the size and complexity of a PR, different requirements MUST be applied. Any team member contributing substantially to a PR MUST NOT count against review requirements.
2626
Commits MUST be merged into master using PRs. They MUST NOT be merged into master directly.
27-
* Every merge MUST be approved by at least one team member.
28-
* Non-trivial changes MUST be approved by at least
29-
* two team members, or
30-
* one subsystem maintainer.
31-
* Significant changes MUST be approved by at least
32-
* two team members, AND
33-
* the relevant subsystem maintainer.
27+
- Every merge MUST be approved by at least one team member.
28+
- Non-trivial changes MUST be approved by at least
29+
- two team members, or
30+
- one subsystem maintainer.
31+
- Significant changes MUST be approved by at least
32+
- two team members, AND
33+
- the relevant subsystem maintainer.
3434

3535
PRs MUST be [reviewed](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests) and [approved](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews) via GitHub’s review system.
36-
* Reviewers MAY write comments if approving
37-
* Reviewers MUST write comments if rejecting a PR or if requesting changes.
36+
- Reviewers MAY write comments if approving
37+
- Reviewers MUST write comments if rejecting a PR or if requesting changes.
3838

3939
Once a PR is approved as per above, any team member MAY merge the PR.
4040

@@ -45,28 +45,28 @@ Once a PR is approved as per above, any team member MAY merge the PR.
4545
Grafana uses trunk-based development.
4646

4747
In particular, we found that the following principles match how we work:
48-
* Master and release branches MUST always build without failure.
49-
* Branches SHOULD be merged often. Larger changes SHOULD be activated with feature flags until they are ready. Long-lived development branches SHOULD be avoided.
50-
* Changes MAY be enabled by default once they are in a complete state
51-
* Changes which span multiple PRs MUST be described in an overarching issue or Google Doc.
48+
- Master and release branches MUST always build without failure.
49+
- Branches SHOULD be merged often. Larger changes SHOULD be activated with feature flags until they are ready. Long-lived development branches SHOULD be avoided.
50+
- Changes MAY be enabled by default once they are in a complete state
51+
- Changes which span multiple PRs MUST be described in an overarching issue or Google Doc.
5252

5353
## Releases
5454

5555
Releases MUST follow [Semantic Versioning](https://semver.org/) in naming and SHOULD follow Semantic Versioning as closely as reasonably possible for non-library software.
5656

5757
Release branches MUST be split from the following branches.
58-
* MAJOR release branches MUST be based on master.
59-
* MINOR release branches MUST be based on master.
60-
* PATCH release branches MUST be split from the relevant MINOR release branch’s most current PATCH
58+
- MAJOR release branches MUST be based on master.
59+
- MINOR release branches MUST be based on master.
60+
- PATCH release branches MUST be split from the relevant MINOR release branch’s most current PATCH
6161

6262
Security releases follow the same process but MUST be prepared in secret. Security releases MUST NOT include changes which are not related to the security fix. Normal release processes MUST accommodate the security release process. SECURITY.md MUST be followed.
6363

6464
PRs intended for inclusion in the next PATCH release MUST be labeled with `cherry-pick-needed` so they can be picked up by automated release tooling.
6565

6666
Releases follow the following cadence
67-
* MAJOR: Yearly
68-
* MINOR: Every 4-6 weeks
69-
* PATCH: As needed
67+
- MAJOR: Yearly
68+
- MINOR: Every 4-6 weeks
69+
- PATCH: As needed
7070

7171
Releases SHOULD NOT be delayed by pending changes.
7272

contribute/developer-guide.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,8 @@ Another alternative is to limit the files being watched. The directories that ar
211211

212212
To retain your `ulimit` configuration, i.e. so it will be remembered for future sessions, you need to commit it to your command line shell initialization file. Which file this will be depends on the shell you are using, here are some examples:
213213

214-
* zsh -> ~/.zshrc
215-
* bash -> ~/.bashrc
214+
- zsh -> ~/.zshrc
215+
- bash -> ~/.bashrc
216216

217217
Commit your ulimit configuration to your shell initialization file as follows ($LIMIT being your chosen limit and $INIT_FILE being the initialization file for your shell):
218218

contribute/style-guides/documentation-markdown-guide.md

+13-23
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
11
# Markdown style guide
22

3-
This guide for Markdown style helps keep contributions consistent across all documentation
4-
created for Grafana products. Refer to the guide and update its sections as needed when a
5-
Subject Matter Expert answers a question on Markdown style, or a decision is made about
6-
how to apply Markdown.
3+
This guide for Markdown style helps keep contributions consistent across all documentation created for Grafana products. Refer to the guide and update its sections as needed when a Subject Matter Expert answers a question on Markdown style, or a decision is made about how to apply Markdown.
74

85
## Headers
96

10-
In Markdown, the number of "#" symbols creates different heading levels, similar to
11-
HTML heading levels:
7+
In Markdown, the number of "#" symbols creates different heading levels, similar to HTML heading levels:
128

139
**Example**
1410

15-
* \# is \<h1>.
16-
* \#\# is \<h2>.
17-
* \#\#\# is \<h3>.
11+
- \# is \<h1>.
12+
- \#\# is \<h2>.
13+
- \#\#\# is \<h3>.
1814

1915
Start your document with a single ``#`` for the title of the page. Add the sub-headings with two ``##``.
2016

2117
## Bold and emphasis
2218

23-
* Make text **bold** using two asterisks.
19+
- Make text **bold** using two asterisks.
2420

25-
**Example:** It is ``**important**`` to use GitHub Flavored Markdown emoji consistently.
21+
**Example:** It is ``**important**`` to use GitHub-flavored Markdown emoji consistently.
2622

27-
* Make text ``_emphasized_`` using single `` _underscores_``. Do not use the single asterisk, it can be easily confused with bold.
23+
- Make text ``_emphasized_`` using single `` _underscores_``. Do not use the single asterisk, it can be easily confused with bold.
2824

2925
**Example:** GitHub-flavored markdown emoji should _only_ appear in specific cases.
3026

@@ -35,7 +31,7 @@ Create links to other website by wrapping the display text in square brackets, a
3531

3632
\[text to display](www.website.com)
3733

38-
**Example:** For more information on including emoji in GitHub flavored Markdown, refer to the [webfx page on emoji](https://www.webfx.com/tools/emoji-cheat-sheet/) for a list of emoji.
34+
**Example:** For more information on including emoji in GitHub-flavored markdown, refer to the [webfx page on emoji](https://www.webfx.com/tools/emoji-cheat-sheet/) for a list of emoji.
3935

4036
## Block quotes
4137

@@ -49,8 +45,7 @@ Include block quotes inside text using right-facing arrows:
4945
5046
## Code blocks
5147

52-
Code blocks written with markdown can show off syntax highlighting specific
53-
to different languages. Use three back tics to create a code block:
48+
Code blocks written with markdown can show off syntax highlighting specific to different languages. Use three back tics to create a code block:
5449

5550
```
5651
function testNum(a) {
@@ -62,8 +57,7 @@ function testNum(a) {
6257
}
6358
```
6459

65-
Write the name of the language after the first set of back tics, no spaces,
66-
to show specific syntax highlighting. For example; "\```javascript" produces the following:
60+
Write the name of the language after the first set of back tics, no spaces, to show specific syntax highlighting. For example; "\```javascript" produces the following:
6761

6862
```javascript
6963
function testNum(a) {
@@ -76,10 +70,7 @@ function testNum(a) {
7670
```
7771
## Tables
7872

79-
Construct a table by typing the table headings, and separating them with
80-
a "|" character. Then, add a second line of dashes ("-") separated by
81-
another "|" character. When constructing the table cells, separate each cell data with another
82-
"|".
73+
Construct a table by typing the table headings, and separating them with a "|" character. Then, add a second line of dashes ("-") separated by another "|" character. When constructing the table cells, separate each cell data with another "|".
8374

8475
**Example**
8576

@@ -115,8 +106,7 @@ The list above will always display as:
115106

116107
### Unordered lists
117108

118-
Build a list of points - an unordered or unnumbered list - by
119-
using "\-" (hyphen) characters.
109+
Build a list of points - an unordered or unnumbered list - by using "\-" (hyphen) characters.
120110

121111
**Example**
122112

0 commit comments

Comments
 (0)