Added new file for links definitions#4156
Merged
mrodm merged 1 commit intoelastic:mainfrom Sep 9, 2022
Merged
Conversation
Updated documentation guidelines to include the information related to how the readme templates work. And information related to how to use links with url placeholder.
mrodm
commented
Sep 7, 2022
| @@ -0,0 +1,24 @@ | |||
| links: | |||
Collaborator
Author
There was a problem hiding this comment.
File with links to Elastic documentation guides found. In following PRs, new links could be added.
mrodm
commented
Sep 7, 2022
Comment on lines
+21
to
+36
| Some considerations when these documentation files are written at `_dev/build/docs/*.md`: | ||
| - These files follow the Markdown syntax and leverage the use of templates ([documentation templates info](https://github.com/elastic/elastic-package/blob/main/docs/howto/add_package_readme.md) | ||
| - There are some available functions or placeholders (`fields`, `event`, `url`) that can be used to help writing these docs: | ||
| - More info at [placeholders section](https://github.com/elastic/elastic-package/blob/main/docs/howto/add_package_readme.md#placeholders) | ||
| - Regarding `url` placeholder, this placeholder should be used to add links to Elastic documentation guides (https://www.elastic.co/guide/*) in your documentation: | ||
| - File containing all the links defined is in the root of the directory: [`links_table.yml`](../links_table.yml) | ||
| - If needed, more links to Elastic documentation guides can be added into that file. | ||
| - Example of usage: | ||
| - In documentation files (`_dev/build/docs/*.md`): | ||
| ``` | ||
| {{ url "getting-started-observability" "Elastic guide" }} | ||
| ``` | ||
| - It generates the following link | ||
| ``` | ||
| [Elastic guide](https://www.elastic.co/guide/en/welcome-to-elastic/current/getting-started-observability.html) | ||
| ``` |
Collaborator
Author
There was a problem hiding this comment.
@bmorelli25 Here it is added the cross link mentioned in elastic/elastic-package#936 (comment) between this file and https://github.com/elastic/elastic-package/blob/main/docs/howto/add_package_readme.md
2 tasks
mrodm
commented
Sep 7, 2022
|
|
||
| For step-by-step instructions on how to set up an integration, see the | ||
| [Getting started](https://www.elastic.co/guide/en/welcome-to-elastic/current/getting-started-observability.html) guide. | ||
| {{ url "getting-started-observability" "Getting started" }} guide. |
Collaborator
Author
There was a problem hiding this comment.
Updated snippets to use the new placeholder.
As these guidelines are not related to elastic-package create command I think they can be updated, so developers could use the new placeholder.
4 tasks
💔 Build Failed
Expand to view the summary
Build stats
Test stats 🧪
Steps errors
Expand to view the steps failures
|
🌐 Coverage report
|
Collaborator
Author
|
/test |
Collaborator
Author
|
/test |
4 similar comments
Collaborator
Author
|
/test |
Collaborator
Author
|
/test |
Collaborator
Author
|
/test |
Collaborator
Author
|
/test |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated documentation guidelines to include the information related to how the readme templates work. And information related to how to use links with url placeholder.
What does this PR do?
This PR adds the links definitions file into the root of the working repository (
links_table.yml). This file is going to be used while rendering README files when it is used the new placeholder{{ url <key> <link> }}notation introduced in elastic/elastic-package#938In following PRs, packages will be updated to use this new placeholder in their docs.
Checklist
[ ] I have added an entry to my package'schangelog.ymlfile.Author's Checklist
Related issues