42431e6ad4
* Explore/Logs: Clarify phrasing of newline escape fix tooltip Rewrite the tooltip for the smart feature in PR #31352 that replaces incorrectly escaped newlines in log lines. - Clarify the functionality of the feature to emphasize its interactivity. - Remove language suggesting that the feature is experimental, when we intended to suggest reviewing the results manually for correctness. * Docs: Document escape newlines feature Describe and provide steps for using the "Escape newlines" feature in Explore added in PR #31352. * Rewrite topic lead to clarify conditional behavior * Describe reversion of replacements as a standalone task Reverting the replacements is a separate action, so it should have its own task. This also describes the option's transformation and tightens the task language. * Remove Grafana 7 version qualifier * Clarify escape sequence detection lede on task Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> * Clarify "Remove escaping" state change Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> * Clarify confidence of tooltip content Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Building the docs locally
When you contribute to documentation, it is 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.
Requirements
Docker >= 2.1.0.3 Yarn >= 1.22.4
Build the doc site
- 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/next/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
Images are currently hosted in the grafana/website repo.
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.