Skip to content
Merged
Changes from 1 commit
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
38 changes: 35 additions & 3 deletions docs/migration/guide/move-ref-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ navigation_title: Move reference docs

# Move reference docs from Asciidocalypse

:::{note}
This guide is only for technical writers tasked with moving content out of `elastic/asciidocalypse`.
:::
This page has three parts:
Copy link
Member Author

Choose a reason for hiding this comment

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

sorry, dede


1. [How reference content works in V3](#how-reference-content-works-in-v3) --> potentially interesting for contributors wanting to understand how PR previews and full website builds differ
2. [How to Move Reference Content](#how-to-move-reference-content) --> not really important anymore as the process has been automated
3. [How to manage moved reference content](#how-to-manage-moved-reference-content) --> important for writers who have been assigned to help get reference content merged

## How reference content works in V3

Expand Down Expand Up @@ -71,6 +73,10 @@ For the **full Elastic.co/docs site**, the assembler references the individual c

## How to Move Reference Content

:::{note}
The moving of reference content has been automated. These docs will live on in the short term as a point of reference.
:::

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.

### Step 1: Delete Existing AsciiDoc Files
Expand Down Expand Up @@ -175,3 +181,29 @@ Once everything is confirmed working, merge the pull request.
### Step 6: Update the Tracking Issue

Update [issue#130](https://github.com/elastic/docs-eng-team/issues/130) to reflect the completed migration.

## How to manage moved reference content

You've been assigned to a repo in [issue#130](https://github.com/elastic/docs-eng-team/issues/130). Now what?

The good news is all of the PRs have been opened for you. For each repository, there are two PRs that have been opened:

1. A PR that adds the GH actions for build previews ([example](https://github.com/elastic/ecs-logging/pull/85))
2. A PR that removes asciidoc content and adds md content ([example](https://github.com/elastic/ecs-logging/pull/84))

In an ideal world, your job is to work with codeowners and repo admins to:

1. Get the first PR merged
2. Merge main into the second PR and get it merged

Doing this in two PRs ensures we can merge content with clean CI the first time.

We recognize that some repositories are harder to work in than others. If this is the case, you can cherry pick the commits into a single PR and work with codeowners to get one PR merged. The downside of this approach is that we won't be sure if CI passes until the content is merged. We trust your judgement. Do what is right for your scenario.

### Considerations

Make sure to consider the following things:

* Are these PRs deleting the right content? Is any of the content in the docs dir used, for example, for internal docs that shouldn't be deleted?
* Is the right content being moved?
* Are tests passing? If not, what needs to be done to get the content into a mergable state?
Loading