You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contribute/branching-strategy.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Publishing from the main branch isn’t the best option for all repositories.
23
23
*`main` can contain code and docs for unreleased versions that we don’t want to publish yet.
24
24
* 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.
25
25
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.
27
27
28
28
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.
29
29
@@ -93,11 +93,11 @@ If you don’t want to hold on too many PRs to publish on release day, merge the
93
93
94
94
## Workflow 2: Tagged
95
95
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.
97
97
98
98
### Where to make docs changes [make-changes-td]
99
99
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.
Copy file name to clipboardExpand all lines: docs/contribute/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,12 +39,12 @@ In Docs V3, a single branch is published per repository. This branch is set to `
39
39
40
40
## Report a bug
41
41
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)
44
44
45
45
## Request an enhancement or documentation for a new feature
46
46
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).
48
48
* Make our **build tool (docs-builder)** better: [Start a docs-builder discussion](https://github.com/elastic/docs-builder/discussions)
0 commit comments