Skip to content
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
merged 8 commits into from
Dec 6, 2021

Conversation

ebeahan
Copy link
Member

@ebeahan ebeahan commented Dec 3, 2021

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-level docs directory (excluding the more recently added docs/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 at include:: 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, and docs/additional-info now contain an index.asciidoc for that section's top-level doc page

  • Rename 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

  • The way the doc builds generates the rendered docs site, URLs will not be changed by reorganizing the files in the repo.
  • The site will display the docs the same as before these changes. Again, this is just an administrative change that tidies up the docs.

@ebeahan ebeahan added the DOCS Any issue related to ECS documentation label Dec 3, 2021
@ebeahan ebeahan self-assigned this Dec 3, 2021
@ebeahan ebeahan requested a review from a team December 3, 2021 21:10
@ebeahan
Copy link
Member Author

ebeahan commented Dec 6, 2021

@elasticmachine run elasticsearch-ci/docs

@ebeahan ebeahan merged commit ce6fc71 into elastic:main Dec 6, 2021
@ebeahan ebeahan deleted the fix/reorg-docs-directory-structure branch December 6, 2021 18:04
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
* add missing changelog entry for #1679

* this entry belongs under 8.1
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
Labels
8.0.0 DOCS Any issue related to ECS documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants