elastic / security-docs

Elastic Security Documentation
Other
69 stars 183 forks source link

[Request] Update references to apps and pages re: solution views and classic nav updates in Kibana #5896

Open florent-leborgne opened 1 month ago

florent-leborgne commented 1 month ago

Follow-up to https://github.com/elastic/platform-docs-team/issues/486

With the stateful navigation updates, we need to check that the way we refer to apps and pages in our UI-related guides remains true independently of which navigation users got by default (classic or solution view).

The wording that was discussed and agreed is documented in our style guide.

This specific issue is for Security guides.

The new navigation will arrive with 8.16, so ideally updates should be done by then.

Note: There's a related issue to update the general information about search and navigation principles in Kibana https://github.com/elastic/platform-docs-team/issues/530

jmikell821 commented 1 month ago

Copying from the linked issue above:

Proposed solution After discussing with writers from each solution (also some notes here), we aligned on the following patterns to refer to apps and pages in our product docs:

This wording:

florent-leborgne commented 3 weeks ago

Just a note that we added the new wording to the style guide, and a few slight edits made it into it. Please refer to this https://docs.elastic.dev/tech-writing-guidelines/ui-writing#referring-to-apps-and-pages

natasha-moore-elastic commented 3 weeks ago

Just a note that we added the new wording to the style guide, and a few slight edits made it into it. Please refer to this https://docs.elastic.dev/tech-writing-guidelines/ui-writing#referring-to-apps-and-pages

Thanks @florent-leborgne! @elastic/security-docs, I've edited Janeen's comment above to reflect the new wording.

natasha-moore-elastic commented 3 weeks ago

@elastic/security-docs Just a note that the internal link syntax (<<kibana-navigation-search,global search field>>) won't work in our docset, so we need to use this syntax instead: {kibana-ref}/introduction.html#kibana-navigation-search[global search field].