-
Notifications
You must be signed in to change notification settings - Fork 257
Add product documentation hub pages #7964
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
Draft
florent-leborgne
wants to merge
5
commits into
main
Choose a base branch
from
docs-hub-pages-v1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
30fd045
Add product hub pages for Elasticsearch, Kibana, Logstash, and Elasti…
florent-leborgne 1f5e423
Assign CODEOWNERS for product hub pages
florent-leborgne 51fa78c
Fix hub page links that failed the docs-content build
florent-leborgne bb536ea
Apply suggestion from @florent-leborgne
florent-leborgne f7814ad
Fill Kibana hub gaps for interface, ingest, and AI Assistant
florent-leborgne 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| name: docs-hub-whats-new | ||
| disable-model-invocation: true | ||
| description: Refresh the What's new cards on Elastic product hub pages. Use when updating hub-whats-new.yml after a stack release, or when the user asks to refresh hub What's new content. | ||
| --- | ||
|
|
||
| # Refresh hub What's new cards | ||
|
|
||
| Update `hub-whats-new.yml` at the docs-content repo root. Hub pages render that file with `{whats-new}` and `:product: elasticsearch`, `kibana`, or `logstash`. | ||
|
|
||
| The Elastic Stack hub does not use this file. It links to product and solution release notes with a regular `{card-group}`. | ||
|
|
||
| ## When to run | ||
|
|
||
| After a stack minor GA (for example 9.5.0), or when the user asks to refresh the hub cards. Patch releases (9.5.1) usually do not change the cards unless a highlight was wrong. | ||
|
|
||
| ## Sources (in this order) | ||
|
|
||
| Read these. Do not scrape changelog YAML, docs-builder internals, or unpublished bundles. | ||
|
|
||
| 1. **Published release notes** for the target minor. Use the rendered pages, not GitHub source that may lag: | ||
| - [Elasticsearch](https://www.elastic.co/docs/release-notes/elasticsearch) | ||
| - [Kibana](https://www.elastic.co/docs/release-notes/kibana) | ||
| - [Logstash](https://www.elastic.co/docs/release-notes/logstash) | ||
| 2. **Official what's-new blog** for the same minor, for example [Elastic 9.5](https://www.elastic.co/blog/whats-new-elastic-9-5-0). Use the blog to decide which items are the story of the release. Confirm each item against the published release notes before you keep it. | ||
| 3. **Existing docs pages** in this repo (or `repo://` targets in other docs repos) for the `link:` on each card. Every link must resolve. | ||
|
|
||
| If the blog and the release notes disagree, the published release notes win for facts. The blog wins for which items belong on the hub. | ||
|
|
||
| ## What to write | ||
|
|
||
| Schema: [what's new directive](https://elastic.github.io/docs-builder/syntax/whats-new/). | ||
|
|
||
| For each of `elasticsearch`, `kibana`, and `logstash`: | ||
|
|
||
| - Keep `id: whats-new` so the hub hero can jump to the panel. | ||
| - One `release-links` entry pointing at that product's release notes. | ||
| - One `upgrade-link` pointing at that product's upgrade page. | ||
| - Four or five `items`. Mark **one** item `featured: true`. | ||
| - `date` is the minor version, for example `9.5`. | ||
| - `tag` is a short category (Storage, Dashboards, Monitoring). | ||
| - `title` and `description` are sentence case, present tense, second person or impersonal. No em dashes. Do not use "click" or "choose". | ||
| - Say "Generally available" or "Technical preview" in the description when the release notes do. | ||
|
|
||
| ## Links | ||
|
|
||
| Every `release-links[].url`, `upgrade-link.url`, and `items[].link` must be one of: | ||
|
|
||
| - Site-absolute with `.md`, for example `/manage-data/data-store/columnar.md` | ||
| - Cross-repo, for example `elasticsearch://reference/query-languages/promql.md` | ||
|
|
||
| Do not use `https://www.elastic.co/docs/...` for pages this site publishes. Do not use relative paths. | ||
|
|
||
| Confirm the file exists before you add the link. For docs-content pages, `git cat-file -e HEAD:<path>` or a working-tree glob. For other repos, use the `repo://` form and confirm the path in that repo. | ||
|
|
||
| If a highlight has no documentation page yet, link to the product release notes and add a `Pending links` note in the PR body. | ||
|
|
||
| ## What not to do | ||
|
|
||
| - Do not invent highlights that are not in the published release notes or the blog. | ||
| - Do not copy changelog YAML entries wholesale. Those lists are complete; the hub is a short story. | ||
| - Do not add an Elastic Stack key to this file. | ||
| - Do not edit `{whats-new}` on the hub Markdown pages. Those pages only name the product key. | ||
|
|
||
| ## PR | ||
|
|
||
| Title: `Refresh hub What's new cards for <version>`. | ||
|
|
||
| Body must list the items you kept, the sources you read (release notes URLs and blog URL), and any pending links. | ||
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
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
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.