7f84e83ffe
* Wip * remove name input from page body * render title & subTitle in datasource page in connections and remove unused prop - uid * styling on actions button group * remove unused props in edit datasource page * set gap as 8px between buttons * move editable datasourcename to the header * add subTitle component * remove useRef and use autoFocus prop * pass false to isDefault when dataSource is undefined * change button text * remove suffix icon * remove unused import - Icon * consolidate duplicate useDataSourceSettingsNav into datasrouces hook * move dataSource context to useDataSourceSettingsNav * remove Explore button in the footer * remove unused props * fix failing test on button group * fix typo on file naming * remove disabled prop * fix param * add test * add test files * disable editing title in readOnly provision datasource * update name should save dataSource * prevent swith toggle change from label clicking and change margin * update tooltip message * use datasource update on header instead of state update * remvoe subTitle component and move subTitle component next to page Info component * Added title * remove subTitle in buildNavModel * replace Button with Badge * make datasourceheader as a component * horizontal gap of 24px between pageInfo and actions components * align page Info value items * accept react node as page info label and add tooltip to Default item * update navId for edit datasource page in connections * update unit testing for Title * fix gen_que * betterer * prettier fix * fix e2e test * add data-testid to nameEditIcon selector * fix tooltip text * fix navId for connections datasources edit page * fix e2e selector: change autoSizeInput to Input * adding ellipsis to EditDataSourceTitle * override grafana-ui titleContainer h1 styles * UI cleanup and apply readOnly to default datasource switch * add period * datasource name validation * title and page info alignment * add feature toggle - dataSourcePageHeader * restore basicSettings component and apply feature toggle * go lint * Revert "title and page info alignment" This reverts commit681ac51f11. * remove editable fields from page Header - name, default datasource switch * fix go test: toggle generator * remove test id * remove alerting badge in BasicSettings component * Revert "remove alerting badge in BasicSettings component" This reverts commitfb33ff9028. * feature toggle on alerting badge * rename component & filename * move DataSourceInfo type * change button to link in test --------- Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> Co-authored-by: Torkel Ödegaard <torkel@grafana.com> Co-authored-by: Miguel Palau Zarza <mpalauzarza@gmail.com>
Building the docs locally
When you contribute to documentation, it's a good practice to build the docs on your local machine to make sure your changes appear as you expect. This README explains the process for doing that.
To build a local version, you need to run a process in a Docker container.
Grafana periodically updates the Docker image, docs-base, to update the styling of the Docs.
Requirements
- Docker >= 2.1.0.3
- Yarn >= 1.22.4
Build the doc site
First, make sure the Docker daemon is running on your machine. Then, follow these steps:
- On the command line, first change to the docs folder:
cd docs. - Run
make docs. This launches a preview of the website with the current grafana docs athttp://localhost:3002/docs/grafana/latest/which will refresh automatically when changes are made to content in thesourcesdirectory.
If you have the grafana/website repo checked out in the same directory as the grafana repo, then you can run make docs-local-static to use local assets (such as images).
Content guidelines
Edit content in the sources directory.
Contributing
Using relref for internal links
Use the Hugo shortcode relref any time you are linking to other internal docs pages.
Syntax is:
{{< relref "example.md" >}}
You might need to add more context for the link (containing folders and so on, folder/example.md) if Hugo says the relref is ambiguous.
Managing redirects
When moving content around or removing pages it's important that users following old links are properly redirected to the new location. We do this using the aliases feature in Hugo.
If you are moving a page, add an aliases entry in the front matter referencing the old location of the page which will redirect the old url to the new location.
If you are removing a page, add an aliases entry in the front matter of the most-applicable page referencing the location of the page being removed.
If you are copying an existing page as the basis for a new one, be sure to remove any aliases entries in the front matter in your copy to avoid conflicting redirects.
Edit the side menu
The side menu is automatically build from the file structure. Use the weight front matter parameter to order pages.
To specify different menu text from the page title, use the front matter parameter menuTitle.
Add images
Please see our help documentation on Image, diagram, and screenshot guidelines for comprehensive information.
Deploy changes to grafana.com
When a PR is merged with changes in the docs/sources directory, those changes are automatically synced by a GitHub action (.github/workflows/publish.yml) to the grafana/website repo.
- A PR that targets the
mainbranch syncs to thecontent/docs/grafana/nextdirectory in thewebsiterepository, and publishes tohttps://grafana.com/docs/grafana/next/. - A PR targeting the
latest/currentrelease branch syncs to thecontent/docs/grafana/latestdirectory in thewebsiterepository, and publishes tohttps://grafana.com/docs/grafana/latest/.
Once the sync is complete, the website will automatically publish to production - no further action is needed.