Skip to content

Commit 5bb5b50

Browse files
committed
Merge branch 'more-guidance-versioning' of github.com:elastic/docs-builder into more-guidance-versioning
2 parents fe70e8d + c239f01 commit 5bb5b50

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/contribute/branching-strategy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Publishing from the main branch isn’t the best option for all repositories.
2323
* `main` can contain code and docs for unreleased versions that we don’t want to publish yet.
2424
* The versioning scheme and release cadence of the product associated with a repository can vary, and it can be inconsistent to have the docs associated with a certain version live in a different branch than the code.
2525

26-
If you choose this publication model for your repository AND that repository includes {{serverless-short}} or {{ecloud}} documentation, you will need to make sure that {{serverless-short}}- and {{ecloud}}-related changes are also backported to the `current` branch in order to be published on time.
26+
If you choose this publication model for your repository AND that repository includes {{serverless-short}} or {{ecloud}} documentation, you will need to make sure that {{serverless-short}}- and {{ecloud}}-related changes are also backported to the branch that is publishing to the public docs site.
2727

2828
You **don't** need to change your branching strategy to enable writing docs about future versions. Review the [continuous deployment workflow](#workflow-1-default-continuous-deployment) and [](cumulative-docs.md) to learn more.
2929

@@ -93,11 +93,11 @@ If you don’t want to hold on too many PRs to publish on release day, merge the
9393

9494
## Workflow 2: Tagged
9595

96-
Learn how to make updates in the continuous deployment branching strategy, where the repo is publishing docs from a specific `version` branch.
96+
Learn how to make updates in the continuous deployment branching strategy, where the repo is publishing docs from a specific version branch.
9797

9898
### Where to make docs changes [make-changes-td]
9999

100-
Initiate the changes by opening a PR against the `main` branch of the repo. The changes will be backported to the relevant version branches as detailed below.
100+
Initiate the changes by opening a PR against the `main` branch of the repo, and backport the changes to the relevant version branches as detailed below.
101101

102102
### How to write those changes [write-changes-td]
103103

docs/contribute/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ In Docs V3, a single branch is published per repository. This branch is set to `
3939

4040
## Report a bug
4141

42-
* It's a **documentation** problem: [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml) *or* [Fix it myself](locally.md). You can open sensitive issues in our [internal repo](https://github.com/elastic/docs-content-internal/issues/new/choose).
43-
* It's a **build tool (docs-builder)** problem: [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml)
42+
* For **documentation** problems: [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml) *or* [Fix it myself](locally.md). You can open sensitive issues in our [internal repo](https://github.com/elastic/docs-content-internal/issues/new/choose).
43+
* For **build tool (docs-builder)** problems: [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml)
4444

4545
## Request an enhancement or documentation for a new feature
4646

47-
* Make the **documentation** better: [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml). You can open sensitive issues in our [internal repo](https://github.com/elastic/docs-content-internal/issues/new/choose).
47+
* Make the **documentation** better: [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml). Elastic employees can open sensitive issues in our [internal repo](https://github.com/elastic/docs-content-internal/issues/new/choose).
4848
* Make our **build tool (docs-builder)** better: [Start a docs-builder discussion](https://github.com/elastic/docs-builder/discussions)
4949

5050
## Work on docs-builder

0 commit comments

Comments
 (0)