Skip to content

Commit 73944c1

Browse files
authored
Docs: Clean up contribute docs (grafana#19716)
1 parent 9843a88 commit 73944c1

9 files changed

+34
-32
lines changed

CONTRIBUTING.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ If you believe you've found a security vulnerability, please read our [security
3131

3232
If you have an idea of how to improve Grafana, submit an [enhancement request](https://github.com/grafana/grafana/issues/new?labels=type%3A+feature+request&template=2-feature_request.md).
3333

34-
We want to make Grafana accessible to even more people. [Submit an accessibility issue](https://github.com/grafana/grafana/issues/new?labels=type%3A+accessibility&template=3-accessibility.md) to help us understand what we can improve.
34+
We want to make Grafana accessible to even more people. Submit an [accessibility issue](https://github.com/grafana/grafana/issues/new?labels=type%3A+accessibility&template=3-accessibility.md) to help us understand what we can improve.
3535

3636
### Triage issues
3737

@@ -54,19 +54,12 @@ Unsure where to begin contributing to Grafana? Start by browsing issues labeled
5454

5555
If you're looking to make a code change, see how to set up your environment for [local development](contribute/developer-guide.md).
5656

57-
When you're ready to contribute, it's time to [Create a pull request](/contribute/pull-request.md).
57+
When you're ready to contribute, it's time to [Create a pull request](/contribute/create-pull-request.md).
5858

5959
#### Contributor License Agreement (CLA)
6060

6161
Before we can accept your pull request, you need to [sign our CLA](https://grafana.com/docs/contribute/cla/). If you haven't, our CLA assistant prompts you to when you create your pull request.
6262

63-
## Community
64-
65-
- Follow [@grafana on Twitter](https://twitter.com/grafana/)
66-
- Read and subscribe to the [Grafana blog](https://grafana.com/blog/)
67-
- If you have a specific question, check out our [discussion forums](https://community.grafana.com).
68-
- For general discussions, join us on the [official Slack](http://slack.raintank.io/).
69-
7063
## Where do I go from here?
7164

7265
- Set up your [development environment](contribute/developer-guide.md).

ISSUE_TRIAGE.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Triaging issues
1+
# Triage issues
22

33
The main goal of issue triage is to categorize all incoming Grafana issues and make sure each issue has all basic information needed for anyone else to understand and be able to start working on it.
44

@@ -12,7 +12,8 @@ Triage helps ensure issues resolve quickly by:
1212
* Giving a contributor the information they need before they commit to resolving an issue.
1313
* Lowering the issue count by preventing duplicate issues.
1414
* Streamlining the development process by preventing duplicate discussions.
15-
* 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.
15+
16+
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.
1617

1718
## Simplified flowchart diagram of the issue triage process
1819

contribute/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contribute
2+
3+
This directory contains guides for contributors to the Grafana project.
4+
5+
- [Create a pull request](create-pull-request.md)
6+
- [Contributing documentation](documentation.md)
7+
- [Developer guide](developer-guide.md)
8+
- [Triage issues](triage-issues.md)
9+
10+
The `style-guides` directory contains style guides for the Grafana software project and documentation.
11+
12+
- [Backend style guide](style-guides/backend.md) for how to style and format backend functionality and code.
13+
- [Documentation style guide](style-guides/documentation-style-guide.md) for how to style and format documentation.
14+
- [Frontend style guide](style-guides/frontend.md) for how to style and format the user-facing functionality and code.
15+
- [Redux framework](style-guides/redux.md) for designing the Grafana redux framework.
16+
- [Themes style guide](style-guides/themes.md) for designing and updating Grafana themes.

contribute/pull-request.md contribute/create-pull-request.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ We're excited that you're considering making a contribution to the Grafana proje
66

77
We know you're excited to create your first pull request. Before we get started, read these resources first:
88

9-
- Learn how to start [Contributing to Grafana](https://grafana.com/docs/contribute/overview/).
9+
- Learn how to start [Contributing to Grafana](/CONTRIBUTING.md).
1010
- Make sure your code follows the relevant [style guides](/contribute/style-guides).
1111

1212
## Your first pull request
@@ -30,16 +30,16 @@ If the pull request fixes a bug:
3030

3131
Pull requests for frontend contributions must:
3232

33-
- Use [Emotion](https://github.com/grafana/grafana/blob/master/style_guides/styling.md) for styling.
33+
- Use [Emotion](/contribute/style-guides/styling.md) for styling.
3434
- Not increase the Angular code base.
3535
- Not use `any` or `{}` without reason.
3636
- Not contain large React components that could easily be split into several smaller components.
3737
- Not contain backend calls directly from components—use actions and Redux instead.
3838

3939
Pull requests for Redux contributions must:
4040

41-
- Use the `actionCreatorFactory` and `reducerFactory` helpers instead of traditional switch statement reducers in Redux. Refer to [Redux framework](https://github.com/grafana/grafana/tree/master/style_guides/redux.md) for more details.
42-
- Use `reducerTester` to test reducers. Refer to [Redux framework](https://github.com/grafana/grafana/tree/master/style_guides/redux.md) for more details.
41+
- Use the `actionCreatorFactory` and `reducerFactory` helpers instead of traditional switch statement reducers in Redux. Refer to [Redux framework](/contribute/style-guides/redux.md) for more details.
42+
- Use `reducerTester` to test reducers. Refer to [Redux framework](/contribute/style-guides/redux.md) for more details.
4343
- Not contain code that mutates state in reducers or thunks.
4444
- Not contain code that accesses the reducers state slice directly. Instead, the code should use state selectors to access state.
4545

contribute/developer-guide.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ app_mode = development
129129

130130
By now, you should be able to build and test a change you've made to the Grafana source code. In most cases, you need to add at least one data source to verify the change.
131131

132-
To set up data sources for your development environment, go to the [devenv](devenv) directory in the Grafana repository:
132+
To set up data sources for your development environment, go to the [devenv](/devenv) directory in the Grafana repository:
133133

134134
```
135135
cd devenv
@@ -149,7 +149,7 @@ make devenv sources=influxdb,loki
149149

150150
The script generates a Docker Compose file with the databases you specify as `sources`, and runs them in the background.
151151

152-
See the repository for all the [available data sources](https://github.com/grafana/grafana/tree/master/devenv/docker/blocks). Note that some data sources have specific Docker images for macOS, e.g. `prometheus_mac`.
152+
See the repository for all the [available data sources](/devenv/docker/blocks). Note that some data sources have specific Docker images for macOS, e.g. `prometheus_mac`.
153153

154154
## Build a Docker image
155155

@@ -199,5 +199,6 @@ Another alternative is to limit the files being watched. The directories that ar
199199
## Next steps
200200

201201
- Read our [style guides](/contribute/style-guides).
202-
- Learn how to [Create a pull request](/contribute/pull-request.md).
203-
- [Architecture](architecture).
202+
- Learn how to [Create a pull request](/contribute/create-pull-request.md).
203+
- Read [How to contribute to Grafana as a junior dev](https://medium.com/@ivanahuckova/how-to-contribute-to-grafana-as-junior-dev-c01fe3064502) by [Ivana Huckova](https://medium.com/@ivanahuckova).
204+
- Read about the [architecture](architecture).

contribute/documentation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ For general discussions on documentation, you’re welcome to join the `#docs` c
2323

2424
## Style and formatting
2525

26-
All Grafana documentation is written using [Markdown](https://en.wikipedia.org/wiki/Markdown), and can be found in the [docs](https://github.com/grafana/grafana/tree/master/docs) directory in the [Grafana GitHub repository](https://github.com/grafana/grafana). The [documentation website](https://grafana.com/docs) is generated with [Hugo](https://gohugo.io) which uses [Blackfriday](https://github.com/russross/blackfriday) as its Markdown rendering engine.
26+
All Grafana documentation is written using [Markdown](https://en.wikipedia.org/wiki/Markdown), and can be found in the [docs](/docs) directory in the [Grafana GitHub repository](https://github.com/grafana/grafana). The [documentation website](https://grafana.com/docs) is generated with [Hugo](https://gohugo.io) which uses [Blackfriday](https://github.com/russross/blackfriday) as its Markdown rendering engine.
2727

2828
### Documentation structure
2929

3030
The Grafana documentation is organized into topics, called _sections_. You can take a look at the current build at [grafana.com/docs/](https://grafana.com/docs/).
3131

32-
Each top-level section is located under the [docs/sources](https://github.com/grafana/grafana/tree/master/docs/sources) directory. Subsections are added by creating a subdirectory in the directory of the parent section.
32+
Each top-level section is located under the [docs/sources](/docs/sources) directory. Subsections are added by creating a subdirectory in the directory of the parent section.
3333

3434
For each section, an `_index.md` file provides an overview of the topic.
3535

contribute/style-guides/README.md

-9
This file was deleted.

contribute/style-guides/backend.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We enforce strict `gofmt` formatting and use some linters on our codebase. You c
1010
$ make lint-go
1111
```
1212

13-
We use [revive](https://github.com/mgechev/revive) as a go linter, and do enforce our [custom config](https://github.com/grafana/grafana/blob/master/conf/revive.toml) for it.
13+
We use [revive](https://github.com/mgechev/revive) as a go linter, and do enforce our [custom config](/conf/revive.toml) for it.
1414

1515
The end goal is to follow the golint. And the approuch for reachin that goal is to lint all parts of the codebase that we are currently working on and enable stricter linting for more areas as we go.
1616

contribute/triage-issues.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Investigate issues that we haven't been able to reproduce yet. In some cases, th
2525

2626
Use [GitHub reactions](https://help.github.com/en/articles/about-conversations-on-github#reacting-to-ideas-in-comments) to let us know what's important to you. Vote on bugs if you've experienced the same problem. **Don't vote, or react, by commenting on the issue.**
2727

28-
Read more about [how we prioritize issues](https://github.com/grafana/grafana/blob/master/ISSUE_TRIAGE.md#4-prioritization-of-issues).
28+
Read more about [how we prioritize issues](/ISSUE_TRIAGE.md#4-prioritization-of-issues).
2929

3030
## Report duplicates
3131

0 commit comments

Comments
 (0)