-
Notifications
You must be signed in to change notification settings - Fork 32
Restructure doc and add inline examples #1793
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+270
−195
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
f0b5a98
Restructure doc and add inline examples
theletterf 7f8e4a3
Update docs/syntax/applies.md
theletterf b0b2c2b
Update docs/syntax/_snippets/inline-level-applies-examples.md
theletterf 44449e2
Peer edits
theletterf f7a13e0
Merge branch 'update-applies-to-docs' of github.com:elastic/docs-buil…
theletterf 0d668fc
Move examples
theletterf 2976e81
Move section
theletterf 78eed98
Clarify note
theletterf e9bd2a0
Update docs/syntax/_snippets/inline-level-applies-examples.md
theletterf 1eb0822
Merge branch 'main' into update-applies-to-docs
theletterf b84fa54
Merge branch 'main' into update-applies-to-docs
theletterf 080f1bb
Update docs/syntax/applies.md
theletterf d144d13
Update docs/_snippets/applies_to-key.md
theletterf af62c0b
Update docs/syntax/_snippets/section-level-applies-examples.md
theletterf 78d20f4
Update docs/syntax/_snippets/section-level-applies-examples.md
theletterf ae3efe7
Update docs/syntax/quick-ref.md
theletterf 23cca2e
Merge branch 'main' into update-applies-to-docs
theletterf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| ::::::{dropdown} Basic example | ||
|
|
||
| :::::{tab-set} | ||
|
|
||
| ::::{tab-item} Output | ||
|
|
||
| **Spaces** let you organize your content and users according to your needs. | ||
|
|
||
| - Each space has its own saved objects. | ||
| - {applies_to}`serverless: unavailable` Each space has its own navigation, called solution view. | ||
|
|
||
| :::: | ||
|
|
||
| ::::{tab-item} Markdown | ||
| ```markdown | ||
| **Spaces** let you organize your content and users according to your needs. | ||
|
|
||
| - Each space has its own saved objects. | ||
| - {applies_to}`serverless: unavailable` Each space has its own navigation, called solution view. | ||
| ``` | ||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| :::::: | ||
|
|
||
| ::::::{dropdown} Product-specific applicability with version information | ||
|
|
||
| This example shows how to use directly a key from the second level of the `applies_to` data structure, like `edot_python:`. | ||
|
|
||
| :::::{tab-set} | ||
|
|
||
| ::::{tab-item} Output | ||
|
|
||
| - {applies_to}`edot_python: preview 1.7.0` | ||
| - {applies_to}`apm_agent_java: beta 1.0.0` | ||
|
|
||
| :::: | ||
|
|
||
| ::::{tab-item} Markdown | ||
| ```markdown | ||
| - {applies_to}`edot_python: preview 1.7.0` | ||
| - {applies_to}`apm_agent_java: beta 1.0.0` | ||
| ``` | ||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| :::::: | ||
|
|
||
| ::::::{dropdown} Multiple products and states in a single inline statement | ||
|
|
||
| :::::{tab-set} | ||
|
|
||
| ::::{tab-item} Output | ||
|
|
||
| - {applies_to}`serverless: ga` {applies_to}`stack: ga 9.1.0` | ||
| - {applies_to}`edot_python: preview 1.7.0, ga 1.8.0` {applies_to}`apm_agent_java: beta 1.0.0, ga 1.2.0` | ||
| - {applies_to}`stack: ga 9.0` {applies_to}`eck: ga 3.0` | ||
|
|
||
| :::: | ||
|
|
||
| ::::{tab-item} Markdown | ||
| ```markdown | ||
| - {applies_to}`serverless: ga` {applies_to}`stack: ga 9.1.0` | ||
| - {applies_to}`edot_python: preview 1.7.0, ga 1.8.0` {applies_to}`apm_agent_java: beta 1.0.0, ga 1.2.0` | ||
| - {applies_to}`stack: ga 9.0` {applies_to}`eck: ga 3.0` | ||
| ``` | ||
| :::: | ||
|
|
||
| ::::: | ||
| :::::: | ||
|
|
||
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,41 @@ | ||
| * The whole page is generally applicable to {{stack}} 9.0 and to {{serverless-short}}, but one specific section isn’t applicable to {{serverless-short}} (and there is no alternative for it): | ||
|
|
||
| ````md | ||
| --- | ||
| applies_to: | ||
| stack: ga | ||
| serverless: ga | ||
| --- | ||
|
|
||
| # Spaces | ||
|
|
||
| [...] | ||
|
|
||
| ## Configure a space-level landing page [space-landing-page] | ||
| ```{applies_to} | ||
| serverless: unavailable | ||
| ``` | ||
| ```` | ||
| % I think we wanted to not specify stack here | ||
|
|
||
| * The whole page is generally applicable to all deployment types, but one specific paragraph only applies to {{ech}} and {{serverless-short}}, and another paragraph only applies to {{ece}}: | ||
|
|
||
| ````md | ||
| ## Cloud organization level security [cloud-organization-level] | ||
| ```{applies_to} | ||
| deployment: | ||
| ess: ga | ||
| serverless: ga | ||
| ``` | ||
|
|
||
| [...] | ||
|
|
||
| ## Orchestrator level security [orchestrator-level] | ||
| ```{applies_to} | ||
| deployment: | ||
| ece: ga | ||
| ``` | ||
|
|
||
| [...] | ||
| ```` | ||
| :::::{dropdown} Applicable to Stack and Serverless, minus a section | ||
|
|
||
| ````markdown | ||
| --- | ||
| applies_to: | ||
| stack: ga | ||
| serverless: ga | ||
| --- | ||
|
|
||
| # Spaces | ||
|
|
||
| [...] | ||
|
|
||
| #### Configure a space-level landing page [space-landing-page] | ||
| ```{applies_to} | ||
| serverless: unavailable | ||
| ``` | ||
| ```` | ||
| ::::: | ||
|
|
||
| :::::{dropdown} Applicable to all deployment types, but some paragraphs are specific to other deployment types | ||
|
|
||
| ````markdown | ||
| #### Cloud organization level security [cloud-organization-level] | ||
| ```{applies_to} | ||
| serverless: ga | ||
| deployment: | ||
| ess: ga | ||
| ``` | ||
|
|
||
| [...] | ||
|
|
||
| #### Orchestrator level security [orchestrator-level] | ||
| ```{applies_to} | ||
| deployment: | ||
| ece: ga | ||
| ``` | ||
|
|
||
| [...] | ||
| ```` | ||
| ::::: |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.