mirror of
https://github.com/grafana/grafana.git
synced 2025-08-02 04:19:25 +08:00
Docs: Added developer-resources.md (#21806)
* Added developer-resources.md Added Developer resources and updated menu.yaml file * Updated menu.yaml Updated menu.yaml, changed folder name, and removed redundant file building_from_source.md and containing folder * Removed links to deleted file
This commit is contained in:
@ -35,10 +35,6 @@ aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin",
|
|||||||
</div>
|
</div>
|
||||||
<h5>Nightly Builds</h5>
|
<h5>Nightly Builds</h5>
|
||||||
</a>
|
</a>
|
||||||
<div class="nav-cards__item nav-cards__item--install">
|
|
||||||
<h5>For other platforms read the <a href="{{< relref "project/building_from_source.md" >}}">build from source</a>
|
|
||||||
instructions for more information.</h5>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<h2>Guides</h2>
|
<h2>Guides</h2>
|
||||||
|
@ -7,6 +7,3 @@ name = "Contribute"
|
|||||||
identifier = "contribute"
|
identifier = "contribute"
|
||||||
weight = 20
|
weight = 20
|
||||||
+++
|
+++
|
||||||
|
|
||||||
### Contribute info
|
|
||||||
|
|
48
docs/sources/developers/developer-resources.md
Normal file
48
docs/sources/developers/developer-resources.md
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
+++
|
||||||
|
title = "Developer resources"
|
||||||
|
description = "Resources for Grafana developers"
|
||||||
|
keywords = ["grafana", "documentation", "developers", "resources"]
|
||||||
|
type = "docs"
|
||||||
|
[menu.docs]
|
||||||
|
name = "Grafana resources"
|
||||||
|
identifier = "Developer resources"
|
||||||
|
weight = 30
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Developer resources
|
||||||
|
|
||||||
|
This page lists resources for developers who want to contribute to the Grafana software ecosystem or build plugins for Grafana.
|
||||||
|
|
||||||
|
##
|
||||||
|
General resources
|
||||||
|
These resources are useful for all developers.
|
||||||
|
|
||||||
|
* [Contributing to Grafana](https://github.com/grafana/grafana/blob/master/CONTRIBUTING.md): Start here to learn how you can contribute your skills to make Grafana even better.
|
||||||
|
|
||||||
|
* [Developer guide](https://github.com/grafana/grafana/blob/master/contribute/developer-guide.md): A guide to help you get started developing Grafana software, includes instructions for how to configure Grafana for development.
|
||||||
|
|
||||||
|
* [Contributing to documentation](https://github.com/grafana/grafana/blob/master/contribute/documentation.md): A guide to help you contribute to Grafana documentation, includes links to beginner-friendly issues.
|
||||||
|
|
||||||
|
* [Architecture guides](https://github.com/grafana/grafana/tree/master/contribute/architecture): These guides explain Grafana’s background architecture.
|
||||||
|
|
||||||
|
* [Create a pull request](https://github.com/grafana/grafana/blob/master/contribute/create-pull-request.md): A guide for new contributors about how to create your first Grafana pull request.
|
||||||
|
|
||||||
|
* [REST APIs](https://grafana.com/docs/grafana/latest/http_api/) allow you to interact programmatically with the Grafana backend.
|
||||||
|
|
||||||
|
## Best practices and style
|
||||||
|
|
||||||
|
Our [style guides](https://github.com/grafana/grafana/tree/master/contribute/style-guides) outline Grafana style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding!
|
||||||
|
|
||||||
|
* [Backend style guide](https://github.com/grafana/grafana/blob/master/contribute/style-guides/backend.md) explains how we want to write Go code in the future.
|
||||||
|
|
||||||
|
* [Documentation style guide](https://github.com/grafana/grafana/blob/master/contribute/style-guides/documentation-style-guide.md) applies to all documentation created for Grafana products.
|
||||||
|
|
||||||
|
* [End to end test framework](https://github.com/grafana/grafana/blob/master/contribute/style-guides/e2e.md) provides guidance for Grafana e2e tests.
|
||||||
|
|
||||||
|
* [Frontend style guide](https://github.com/grafana/grafana/blob/master/contribute/style-guides/frontend.md) provides rules and guidance on developing in React for Grafana.
|
||||||
|
|
||||||
|
* [Redux framework](https://github.com/grafana/grafana/blob/master/contribute/style-guides/redux.md) explains how Grafana handles Redux boilerplate code.
|
||||||
|
|
||||||
|
* [Styling Grafana](https://github.com/grafana/grafana/blob/master/contribute/style-guides/styling.md) expands on styling React components with Emotion.
|
||||||
|
|
||||||
|
* [Theming Grafana](https://github.com/grafana/grafana/blob/master/contribute/style-guides/themes.md) explains how to use themes and ThemeContext in Grafana code.
|
@ -27,7 +27,7 @@ The following operating systems are supported for Grafana installation:
|
|||||||
|
|
||||||
While you can install Grafana on other operating systems, we do not recommend doing so and do not provide support for that use case.
|
While you can install Grafana on other operating systems, we do not recommend doing so and do not provide support for that use case.
|
||||||
|
|
||||||
Installation of Grafana on other operating systems is possible, but not supported. Please see the [building from source]({{< relref "../project/building_from_source/#building-grafana-from-source" >}}) guide for more information.
|
Installation of Grafana on other operating systems is possible, but not supported.
|
||||||
|
|
||||||
## Hardware recommendations
|
## Hardware recommendations
|
||||||
|
|
||||||
|
@ -13,8 +13,6 @@
|
|||||||
link: /installation/mac/
|
link: /installation/mac/
|
||||||
- name: Install using Docker
|
- name: Install using Docker
|
||||||
link: /installation/docker/
|
link: /installation/docker/
|
||||||
- name: Building from source
|
|
||||||
link: /project/building_from_source/
|
|
||||||
- name: Upgrade Grafana
|
- name: Upgrade Grafana
|
||||||
link: /installation/upgrading/
|
link: /installation/upgrading/
|
||||||
- name: Administration
|
- name: Administration
|
||||||
@ -259,9 +257,9 @@
|
|||||||
- name: Plugins
|
- name: Plugins
|
||||||
link: /plugins/
|
link: /plugins/
|
||||||
children:
|
children:
|
||||||
- name: Installing Plugins
|
- name: Install Plugins
|
||||||
link: /plugins/installation/
|
link: /plugins/installation/
|
||||||
- name: Developing Plugins
|
- name: Develop Plugins
|
||||||
link: /plugins/developing/
|
link: /plugins/developing/
|
||||||
children:
|
children:
|
||||||
- link: /plugins/developing/development/
|
- link: /plugins/developing/development/
|
||||||
@ -331,10 +329,12 @@
|
|||||||
link: /http_api/team/
|
link: /http_api/team/
|
||||||
- name: Users
|
- name: Users
|
||||||
link: /http_api/user/
|
link: /http_api/user/
|
||||||
- name: Contribute
|
- name: Developers
|
||||||
link: /contribute/
|
link: /developers/
|
||||||
children:
|
children:
|
||||||
|
- name: Developer resources
|
||||||
|
link: /developers/developer-resources/
|
||||||
- name: Contributor License Agreement (CLA)
|
- name: Contributor License Agreement (CLA)
|
||||||
link: /contribute/cla/
|
link: /developers/cla/
|
||||||
- name: Docs Archive
|
- name: Docs Archive
|
||||||
link: /archive/
|
link: /archive/
|
||||||
|
@ -16,7 +16,7 @@ Grafana already has a strong community of contributors and plugin developers. By
|
|||||||
|
|
||||||
## Short version
|
## Short version
|
||||||
|
|
||||||
1. [Setup grafana](http://docs.grafana.org/project/building_from_source/)
|
1. [Set up Grafana](https://github.com/grafana/grafana/blob/master/contribute/developer-guide.md)
|
||||||
2. Clone an example plugin into ```/var/lib/grafana/plugins``` or `data/plugins` (relative to grafana git repo if you're running development version from source dir)
|
2. Clone an example plugin into ```/var/lib/grafana/plugins``` or `data/plugins` (relative to grafana git repo if you're running development version from source dir)
|
||||||
3. Use one of our example plugins as starting point
|
3. Use one of our example plugins as starting point
|
||||||
|
|
||||||
@ -96,7 +96,7 @@ export {
|
|||||||
|
|
||||||
There are three ways that you can start developing a Grafana plugin.
|
There are three ways that you can start developing a Grafana plugin.
|
||||||
|
|
||||||
1. Setup a Grafana development environment. [(described here)](http://docs.grafana.org/project/building_from_source/) and place your plugin in the ```data/plugins``` folder.
|
1. Set up a Grafana development environment. [(described here)](https://github.com/grafana/grafana/blob/master/contribute/developer-guide.md) and place your plugin in the ```data/plugins``` folder.
|
||||||
2. Install Grafana and place your plugin in the plugins directory which is set in your [config file](/installation/configuration). By default this is `/var/lib/grafana/plugins` on Linux systems.
|
2. Install Grafana and place your plugin in the plugins directory which is set in your [config file](/installation/configuration). By default this is `/var/lib/grafana/plugins` on Linux systems.
|
||||||
3. Place your plugin directory anywhere you like and specify it grafana.ini.
|
3. Place your plugin directory anywhere you like and specify it grafana.ini.
|
||||||
|
|
||||||
|
@ -1,8 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "Project"
|
|
||||||
type = "docs"
|
|
||||||
identifier = "project"
|
|
||||||
weight = 6
|
|
||||||
+++
|
|
||||||
|
|
||||||
# Welcome to the grafana project
|
|
@ -1,11 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "Building from source"
|
|
||||||
type = "docs"
|
|
||||||
[menu.docs]
|
|
||||||
parent = "installation"
|
|
||||||
weight = 700
|
|
||||||
+++
|
|
||||||
|
|
||||||
# Building Grafana from source
|
|
||||||
|
|
||||||
Refer to the [Grafana developer guide](https://github.com/grafana/grafana/blob/master/contribute/developer-guide.md) for information about building Grafana from the source code.
|
|
Reference in New Issue
Block a user