Isabel
89f63dcddb
Docs: fix broken link to moved content ( #77147 )
...
* Remove docs/reference shortcode for moved content
* Updated transformers content file
* Updated README.md to make Transformations section more prominent
* Updated index file to make super clear where you must update this content
* Added doc/ref back in with new format
* Removed bracket
* Added missing quotation marks
* Added reference style link and removed link from docs/ref shortcode
* Updated link
* Add warning to only use reference style links in content.ts
* ihm/251023-link-fix/ update scripts/docs/generate-transformations.ts with proposed changes, and build markdown
* ihm/251023-link-fix/ build docs
* Fix extraneous whitespace
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Add precheck for ONESHELL support
Otherwise the recipe doesn't work.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: jev forsberg <jev.forsberg@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-10-25 14:09:33 -04:00
Jev Forsberg
41db5b645c
Transformations: Separate useful doc content for UI use ( #75781 )
...
* baldm0mma/doc_builder/ add to gitignore
* baldm0mma/doc_builder/ add makefile commands
* baldm0mma/doc_builder/ add content
* baldm0mma/doc_builder/ format content
* baldm0mma/doc_builder/ update makefile
* baldm0mma/docs_builder/ update content
* baldm0mma/doc_builder/ add back content
* baldm0mma/doc_builder/ run builder
* baldm0mma/doc_builder/ update naming
* baldm0mma/doc_builder/ remove unused note
* baldm0mma/doc_builder/ update template
* baldm0mma/doc_builder/ add new line in makefile
* baldm0mma/doc_builder/ rem new line
* baldm0mma/doc_builder/ add final line
* Much of this full PR was Co-Authored-By: Jack Baldry <jack.baldry@grafana.com>
* baldm0mma/doc_builder/ update readme
* baldm0mma/doc_builder/ update guidlines
* Update scripts/docs/generate-transformations.ts
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Update scripts/docs/generate-transformations.ts
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Update scripts/docs/generate-transformations.ts
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Update scripts/docs/generate-transformations.ts
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Update scripts/docs/generate-transformations.ts
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Update docs/README.md
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Update docs/README.md
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Update scripts/docs/generate-transformations.ts
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* baldm0mma/doc_builder/ update concat
* baldmomma/doc_builder/ finish concat table
* baldm0mma/docs_builder/ update with suggestions
* baldm0mma/doc_builder/ update content to use getHelperDocs
* baldm0mma/doc_builder/ update calculateField
* baldm0mma/doc_builder/ update to byRefId
* baldm0mma/doc_builder/ update filterByValue
* baldm0mma/doc_builder/ update filterFieldsByName
* baldm0mma/doc_builder/ update formatTime
* baldm0mma/doc_builder/ update groupBy
* baldm0mma/doc_builder/ update groupingToMatrix
* baldm0mma/doc_update/ update heatmap
* baldm0mma/doc_builder/ update histogram
* baldm0mma/doc_builder/ update joinByField
* baldm0mma/doc_builder/ update joinByLabels
* baldm0mma/doc_builder/ update labelsToFields
* baldm0mma/doc_builder/ update limit
* baldm0mma/doc_builder/ update merge
* baldm0mma/doc_builder/ update organize
* baldm0mma/doc_builder/ update partitionByValues
* baldm0mma/doc_builder/ update prepareTimeSeries
* baldm0mma/doc_builder/ update reduce
* baldm0mma/doc_builder/ update renameByRegex
* baldm0mma/doc_builder/ update rowsToFields
* baldm0mma/doc_builder/ update seriesToRows
* baldm0mma/doc_builder/ update sortBy
* baldm0mma/doc_builder/ update spatial
* baldm0mma/doc_builder/ update timeSeriesTable
* baldm0mma/doc_builder/ rerender all
* baldm0mma/doc_builder/ update calculateField
* baldm0mma/doc_builder/ gitignore conflicts
* baldm0mma/doc_builder/ add formatString
* baldm0mma/doc_builder/ update vars
* baldm0mma/doc_builder/ update naming
* baldm0mma/doc_builder/ rerender markdown
* Update public/app/features/transformers/docs/content.ts
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* baldm0mma/doc_builder/ update content
* baldm0mma/doc_builder/ add to codeownders
* baldm0mma/doc_builder/ correct spelling
* baldm0mma/doc_builder/ update comment
---------
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-10-24 10:30:10 -06:00
Matt Dodson
35f649e530
Docs, update README to explain local build ( #61086 )
...
Update README.md
2023-05-02 13:28:23 +01:00
Michael Mandrus
a0602a2a78
Chore: Update docs readme on adding images ( #62892 )
...
* Update images guidelines section of readme
* Update README.md
2023-02-03 11:10:41 -05:00
Jack Baldry
13c4ee1da0
Fix URL of docs preview ( #62704 )
...
Latest is used for consistency with CI
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-02-01 16:16:26 +00:00
Robby Milo
846842eb99
Update README.md ( #43358 )
2022-02-17 14:27:15 +00:00
Paschalis Tsilias
eed9e5543d
Fix link to contribute/documentation page ( #44322 )
...
Signed-off-by: Paschalis Tsilias <paschalis.tsilias@grafana.com>
2022-01-25 13:58:48 -05:00
Andrej Ocenas
14d90b0cf8
Link to contributing docs and fix some image markdown examples ( #39726 )
2021-09-30 12:59:35 -04:00
Ivana Huckova
7f8576ee37
Postgres: For template queries return [] and not error ( #38060 )
...
* Postgres: For template queries return [] and not error
* remove the console error
* update mssql and mysql
Co-authored-by: Ying WANG <ying.wang@grafana.com>
2021-08-19 13:43:41 +02:00
Robby Milo
552eed75e2
docs - update publishing details, add menuTitle instructions ( #37441 )
...
* docs - update publishing details, add menuTitle instructions.
* Update docs/README.md
Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
* Update docs/README.md
Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
* Apply suggestions from code review
Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
Co-authored-by: Daniel Lee <dan.limerick@gmail.com>
2021-08-18 19:59:04 +02:00
Dan Cech
5a56594f0c
add instructions for managing redirects when moving docs pages around ( #37113 )
2021-07-22 13:46:40 -04:00
Arve Knudsen
c2c1ec7d0f
Chore: Move from master to main branch ( #33693 )
...
* Chore: Move from master branch to main
Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
* CI: Upgrade build pipeline tool to v2
Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-05-06 16:29:29 +02:00
Torkel Ödegaard
9873809547
Docs: Sync master docs against next version ( #32602 )
...
Co-authored-by: Robby Milo <robbymilo@gmail.com>
2021-04-12 09:42:10 +02:00
Robby Milo
57edbb4157
docs: add quick build ( #31663 )
...
* add quick docs build
* update docs
2021-03-12 08:53:17 -05:00
Kyle Brandt
1588d7235c
Docs: include Makefile option for local assets ( #30455 )
...
for use when also having the website repo checked out, and you want local images.
Also make vars for some of the repeated items.
2021-01-21 07:27:54 -05:00
Diana Payton
df8f63de7f
Update README.md ( #29075 )
2020-11-12 10:51:31 -08:00
Robby Milo
abee02dbcd
Docs: updates for file-based menu ( #28500 )
...
* initial
* cleanup
* remove bad aliases
* cleanup, fix links
* add docs-file-based-command
* update docs
* update readme
* fix broken links
* fix spelling
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-11-09 12:26:49 -08:00
Anthony D'Atri
5cded1d2cd
docs: a few tweaks for clarity and readability ( #28579 )
...
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-10-27 15:57:29 -04:00
Marcus Andersson
0bb33839f5
Docs: updated cmd to build docs locally to generate docs prior to building site. ( #28371 )
...
* added instructions so we generate docs prior to building them.
* replaced ci script.
* improved according to feedback.
2020-10-22 09:57:56 +02:00
DECarreras
54df058b95
Docs: Fixed lazy numbering in all documentation files ( #27975 )
2020-10-01 12:45:05 -04:00
Robby Milo
8107e735c1
Docs: update loki links, readme ( #26548 )
2020-08-06 12:40:12 -07:00
Robby Milo
a6fac58088
Docs: add test for website build ( #21364 )
...
* add build-docs-website job to circleci
* update commands
* update readme command
* remove container when test finishes
* move build-docs-website to build-branches-and-prs
* update readme
2020-01-14 16:26:00 +01:00
stephenbjm
b630e57290
Docs: Update README.md ( #21274 )
2019-12-30 08:18:51 +01:00
Robby Milo
e5695b155b
Docs: Add minimal hugo build, update docs README ( #20905 )
...
* initial commit
* remove menu and submenu
* improve layout templates, improve README
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* fix typo
* remove layouts
* update readme, makefile
* update docs command
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update docs/README.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2019-12-13 15:47:28 +01:00
Linus Groh
b21a130118
Docs: Update keyboard shortcuts formatting ( #19637 )
...
* Docs: Update keyboard shortcuts formatting in docs
* Docs: Update keystroke separators
* Docs: Remove spaces in keyboard shortcuts
2019-10-07 14:56:00 +02:00
brew-install-buzzwords
618652d16e
Docs: Replace ampersands with and ( #19609 )
2019-10-03 18:20:52 +02:00
Marcus Olsson
2fb301ccaf
Docs: Improve guides for contributing ( #19575 )
...
* Move style guides into contribute directory
* Move contribution guides into contribute directory
* Refactor CONTRIBUTING.md
* Clean up docs/README.md
* Update reference to style guide and minor formatting fixes
* Apply suggestions from code review
Co-Authored-By: gotjosh <josue.abreu@gmail.com>
* Update CONTRIBUTING.md
Co-Authored-By: gotjosh <josue.abreu@gmail.com>
2019-10-03 14:13:58 +02:00
gotjosh
f2ef49f950
Docs: LDAP Debug View documentation ( #19513 )
...
* Docs: Add information regarding the LDAP Debug View
* Add instructions to compress image when adding them to the documentation
* Add a troubleshooting section to the docs documentation
2019-10-01 09:18:59 +01:00
Andrej Ocenas
3bd04d63c4
Docs: Update readme with info about ongoing migration ( #19362 )
2019-09-25 11:27:20 +02:00
Dominik Prokop
433e5ac049
Docs: Update readme to reference correct repo ( #17666 )
2019-06-19 16:10:45 +02:00
Axel Pirek
d2f2c3f220
Fix spelling of your and you're
2018-09-25 12:38:02 +02:00
Daniel Lee
6992b484bc
docs: improvements to building the docs readme
...
Explains that you need to clone the grafana repo if you have not done that already.
2017-06-09 14:27:27 +02:00
Daniel Lee
c5d5d7ac5a
docs: instruction on creating dummy awsconfig
...
To be able to build the docs an awsconfig file must exist for the Dockerfile to copy. This adds an instruction to create an empty, dummy file so that the build will work.
2017-06-08 10:32:57 +02:00
Torkel Ödegaard
71b62f5cf9
Create README.md
2017-06-08 09:15:10 +02:00
Torkel Ödegaard
982dc276d3
Update building docs readme
2017-02-06 10:19:47 +01:00
Tim Bielawa
2b9d260686
docs(rebuild): Include new http api preferences docs in menus ( #5194 )
...
This updates the mkdocs.yml source file such that the HTTP Preferences
API is included in the website navigation bar and in the HTTP API
overview page.
This commit also refreshes the docs/README.md file with more verbose
instructions for building and viewing the documentation locally.
* Original issue: #5069 Document org & user preferences HTTP docs
* Original PR: #5087
Closes #5193
2016-05-27 08:58:42 +02:00
Anton Gilgur
e4baef94bc
docs(ldap): Clarify LDAP features and sample config
...
* Clarify certain features, such as multiple mappings
* Fixup ldap.toml sample config
* Fixup docs README's port number
* Fixup bad link from LDAP docs to Configuration docs
* Fixup some spelling, grammar, and line endings
2015-08-11 19:57:53 -07:00
Jason Wilder
3693f36e59
Add docs for building the docs locally
2015-03-12 14:47:49 -06:00
