-
Notifications
You must be signed in to change notification settings - Fork 431
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
[DOCS] Reorganizing docs directory structure #1679
Merged
ebeahan
merged 8 commits into
elastic:main
from
ebeahan:fix/reorg-docs-directory-structure
Dec 6, 2021
Merged
[DOCS] Reorganizing docs directory structure #1679
ebeahan
merged 8 commits into
elastic:main
from
ebeahan:fix/reorg-docs-directory-structure
Dec 6, 2021
Conversation
This file contains 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
handle new /fields location for index vs field doc files
kgeller
approved these changes
Dec 6, 2021
@elasticmachine run elasticsearch-ci/docs |
ebeahan
added a commit
to ebeahan/ecs
that referenced
this pull request
Dec 6, 2021
* reorganize directory structure of docs * update links * top-level index is controlled by a template * move generated field files into a dedicated dir * account for new usage dir location in tooling * new fields/ locations handle new /fields location for index vs field doc files * correct the j2 index template * move images directory
ebeahan
added a commit
that referenced
this pull request
Dec 6, 2021
* reorganize directory structure of docs * update links * top-level index is controlled by a template * move generated field files into a dedicated dir * account for new usage dir location in tooling * new fields/ locations handle new /fields location for index vs field doc files * correct the j2 index template * move images directory
ebeahan
added a commit
to ebeahan/ecs
that referenced
this pull request
Dec 6, 2021
ebeahan
added a commit
that referenced
this pull request
Dec 6, 2021
ebeahan
added a commit
to ebeahan/ecs
that referenced
this pull request
Dec 6, 2021
ebeahan
added a commit
that referenced
this pull request
Dec 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Reorganize the
docs
folder to match the organization on the rendered docs site.The new directory structure can be browsed on my branch here.
Background
Until now, the ECS
.asciidoc
files were a collection of files under the top-leveldocs
directory (excluding the more recently addeddocs/usage
). This structure was becoming a bit disorganized, and it was hard to understand the docs hierarchy without opening individual files and "to connect the dots" looking atinclude::
statements.Changes
New subdirectories:
docs/using-ecs
docs/fields
docs/migrating
docs/additional-info
The
docs/index.asciidoc
remains the top-level doc file for ECS.docs/using-ecs
,docs/migrating
, anddocs/additional-info
now contain anindex.asciidoc
for that section's top-level doc pageRename specific
.asciidoc
files to remove now redundant prefixes (for example,using-
).Small changes to the asciidoc generator script to accommodate the new directory structure.
Deleted the unused
docs/logstash.asciidoc.disabled
file. Easy to add a file in the future if this is something we decide to pursue.Non-changes