Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/contribute/configure-changelogs-ref.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ Also controls how the `changelog add` command maps GitHub labels to various chan

| Setting | Description |
| ----------------- | ------------------------------------------ |
| `pivot.areas` | Lists the valid area values. Optionally maps area names to GitHub labels (for example, `"Search": ":Search/Search"`). |
| `pivot.areas` | Lists the valid area values. Optionally maps area names to GitHub labels (for example, `"Search Relevance": ":Search Relevance/Search"`). |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

based on your other change, I think this is wrong

Suggested change
| `pivot.areas` | Lists the valid area values. Optionally maps area names to GitHub labels (for example, `"Search Relevance": ":Search Relevance/Search"`). |
| `pivot.areas` | Lists the valid area values. Optionally maps area names to GitHub labels (for example, `"Search": ":Search Relevance/Search"`). |

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We want to remove the catch-all "Search" label - you have to be more specific now. "Search" should not map to "Search Relevance" - I just wanted to leave an example in this documentation.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok. I want @lcawl or @cotti to weigh in here because I don't know how these are used.

fwiw, your change in the other PR does map search directly to relevance. if that's not what you want, you probably need to make some further changes.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair, the other maps the general Search area to "Search Foundations" - it's the closest to the original purpose. I was concerned that removing it all together would break something.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, reading too fast. will leave this for the others regardless :)

| `pivot.highlight` | Defines labels that set the `highlight` flag on changelogs. |
| `pivot.products` | Maps product IDs (and optionally version and lifecycle) to GitHub labels. |
| `pivot.types` | Lists the valid type values (at a minimum, `feature`, `bug-fix`, and `breaking-change`). Optionally maps types to GitHub labels (for example, `bug-fix: ">bug"`). You can also optionally define breaking change subtypes. |
Expand Down Expand Up @@ -354,7 +354,6 @@ For more context, go to [](/contribute/create-changelogs.md#rules).

Controls which changelogs are included in bundles.
These rules are applied by the `docs-builder changelog bundle` and `docs-builder changelog gh-release` commands **after** the primary filter (`--prs`, `--issues`, `--all`, or `--input-products`) has identified the relevant changelogs and **before** the bundle is written.

:::{tip}
The input stage (gathering entries) and bundle filtering stage (filtering for output) are conceptually separate.
:::
Expand Down
Loading