Skip to content

Commit 03b3aad

Browse files
authored
more updates to ref docs (#612)
* Update move-ref-docs.md * Update move-ref-docs.md * Update move-ref-docs.md
1 parent 7d9632f commit 03b3aad

File tree

1 file changed

+46
-3
lines changed

1 file changed

+46
-3
lines changed

docs/migration/guide/move-ref-docs.md

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@ navigation_title: Move reference docs
44

55
# Move reference docs from Asciidocalypse
66

7-
:::{note}
8-
This guide is only for technical writers tasked with moving content out of `elastic/asciidocalypse`.
9-
:::
7+
This page is divided into three sections:
8+
9+
1. [How Reference Content Works in V3](#how-reference-content-works-in-v3) – Useful for contributors who want to understand the difference between PR previews and full website builds.
10+
2. [How to Move Reference Content](#how-to-move-reference-content) – No longer relevant, as the process has been automated.
11+
3. [How to Manage Moved Reference Content](#how-to-manage-moved-reference-content) – Important for writers responsible for merging reference content.
12+
13+
Jump to the relevant section based on your needs.
1014

1115
## How reference content works in V3
1216

@@ -71,6 +75,10 @@ For the **full Elastic.co/docs site**, the assembler references the individual c
7175

7276
## How to Move Reference Content
7377

78+
:::{note}
79+
The moving of reference content has been automated. These docs will live on in the short term as a point of reference.
80+
:::
81+
7482
The steps below explain how to move reference content. You can also take a look at our [sample PR](https://github.com/elastic/apm-agent-android/pull/398), which has specific commits to illustrate some of the steps below.
7583

7684
### Step 1: Delete Existing AsciiDoc Files
@@ -175,3 +183,38 @@ Once everything is confirmed working, merge the pull request.
175183
### Step 6: Update the Tracking Issue
176184

177185
Update [issue#130](https://github.com/elastic/docs-eng-team/issues/130) to reflect the completed migration.
186+
187+
## How to manage moved reference content
188+
189+
You've been assigned to a repository in [issue #130](https://github.com/elastic/docs-eng-team/issues/130). Now what?
190+
191+
The good news: all necessary PRs have already been opened for you. Each repository has two PRs:
192+
193+
1. A PR that adds GitHub Actions for build previews ([example](https://github.com/elastic/ecs-logging/pull/85)).
194+
2. A PR that removes AsciiDoc content and adds Markdown content ([example](https://github.com/elastic/ecs-logging/pull/84)).
195+
196+
### Your Role
197+
198+
Ideally, your job is to work with codeowners and repo admins to:
199+
200+
1. **Get the first PR merged** (to ensure previews work).
201+
2. **Merge `main` into the second PR and get it merged**.
202+
203+
Splitting this into two PRs ensures that content is merged with a clean CI pass on the first attempt.
204+
205+
### Alternative Approach
206+
207+
Some repositories may be more challenging to work with. If needed, you can cherry-pick the commits into a single PR and collaborate with codeowners to get it merged.
208+
209+
**Downside:** We won't know if CI passes until after merging.
210+
**Use your judgment**—choose the best approach for your situation.
211+
212+
### Key Considerations
213+
214+
Before merging, review the following:
215+
216+
- **Is the right content being deleted?** Ensure no essential internal docs are being removed.
217+
- **Is the correct content being moved?** Double-check that everything is in its proper place.
218+
- **Are tests passing?** If not, what adjustments are needed to make the content mergeable?
219+
220+
Let us know if you encounter any blockers. Thanks for your help!

0 commit comments

Comments
 (0)