Change ECS chunking level

[ebeahan]

Updating the ECS book chunking config from 1 to 2. This change will enable adding additional usage sub-sections per fieldset in the ECS field reference.

Example:

The full details of these ECS documentation changes are captured in elastic/ecs#943.

[gtback]

This is fine and does exactly what it claims to do 😁 .

I'll note that in a lot of the docs, writers are moving to longer pages, to make it easier on developers to CTRL-F to find content on a page. Additionally, the pages that currently hold the bulk of the information, like https://www.elastic.co/guide/en/ecs/current/ecs-as.html, are changing to become stubs like https://docs_1970.docs-preview.app.elstc.co/guide/en/ecs/current/ecs-as.html. At least we don't need to add redirects, but I think it's still a suboptimal user experience.

Finally, all of the "Field Reuse" pages have URLs like https://docs_1970.docs-preview.app.elstc.co/guide/en/ecs/current/_field_reuse_6.html. It might be good to update the IDs in the source files before merging this in. That will break existing anchors like https://www.elastic.co/guide/en/ecs/current/ecs-file.html#_field_reuse_6, but those will be changing anyway as this content gets moved onto a new page.

[ebeahan]

Thanks @gtback!

Looking at the preview, this isn't exactly what the ECS team wants either 😅 . I suspect that this preview was built before I merged elastic/ecs#989, which should prevent the large sweeping changes you've noted.

I'll re-run the docs build and verify the changes are as intended.

cc @webmat

[ebeahan]

@elasticmachine, run elasticsearch-ci/docs

[ebeahan]

master and 1.x are now correct in the docs preview, but I have some additional backporting for the other versions (including current/1.6) to perform.

[webmat]

Quick question @gtback, is it possible for us to set the chunking per branch of the ECS docs?

Setting chunking to 2 should only be relevant to our next release, 1.7. Since the pages that require an adjustment in adding [discrete] are generated pages, we need to go modify different versions of the script over the years to make all past versions look right, at this new setting.

If instead we can easily force chunking to 1 in branches 1.0, 1.1, 1.2, 1.3, 1.4, 1.5 and 1.6 from here, I think that would be easier.

[gtback]

Hey @webmat. It's not currently possible to change chunking level per-branch. If it's important, I can look into what level of effort would be needed to add this ability.

An alternative would be to create a new book and move the current one to the "legacy" section, but then you lose some of the ability to switch between the "same" page in different versions, and we might have to choose a different URL. I'd say the cons of that approach probably outweigh the pros, but wanted to at least suggest it.

[webmat]

Alright, thanks @gtback! We'll handle it on our side, then.

[ebeahan]

@elasticmachine, run elasticsearch-ci/docs