Commit graph

5 commits

Author SHA1 Message Date
Gerard Soldevila
fb26c1c683
SKA: Update broken references and URLs (#206836)
## Summary

Updates a number of broken file references and broken links.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>
2025-01-28 03:32:48 +00:00
Spencer
52d235ae49
[docs-utils] remove extra api_docs dir (#148658)
In order to avoid searching the `api_docs` directory at the root of the
repo in VSCode we have to exclude all api_docs dirs from search, so
instead of putting the source of the code that generates the api_docs in
a similarly named dir this just removes that wrapper.
2023-01-10 12:20:35 -07:00
Spencer
6c438b331c
[api-docs] follow the correct schema for frontmatter (#138348)
* [api-docs] follow the correct schema for frontmatter

* rename non-generated summary: usage

* fix yaml comment syntax
2022-08-10 17:17:50 -05:00
Garrett Spong
384626bd0b
[dev_docs] Fixes broken REST API template links (#128069)
## Summary

The REST API template links on the main [Documentation page](https://docs.elastic.dev/kibana-dev-docs/contributing/documentation#rest-apis) are broken. They're pointing to the docs `main` branch and the `docs` repo is still on `master` at this moment.

Old Broken Links:
- [API doc template](https://raw.githubusercontent.com/elastic/docs/main/shared/api-ref-ex.asciidoc)
- [API object definition template](https://raw.githubusercontent.com/elastic/docs/main/shared/api-definitions-ex.asciidoc)

New Fixed Links:
- [API doc template](https://raw.githubusercontent.com/elastic/docs/master/shared/api-ref-ex.asciidoc)
- [API object definition template](https://raw.githubusercontent.com/elastic/docs/master/shared/api-definitions-ex.asciidoc)
2022-03-21 09:06:12 -07:00
Stacey Gammon
e1ac9398d3
Add more details on developer documentation (#126674)
* Docs on docs

* dev docs

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Address review feedback

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Joe Portner <5295965+jportner@users.noreply.github.com>

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>
Co-authored-by: Joe Portner <5295965+jportner@users.noreply.github.com>
2022-03-03 11:44:05 -07:00