Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add rebuild instructions #2865

Merged
merged 11 commits into from
Dec 13, 2023
Merged

Add rebuild instructions #2865

merged 11 commits into from
Dec 13, 2023

Conversation

nkammah
Copy link
Contributor

@nkammah nkammah commented Dec 13, 2023

No description provided.

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

2 similar comments
@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

Triggering rebuilds You can manually trigger a new Buildkite build with any of the below commands:

run docs-build run docs-build rebuild run docs-build warnlinkcheck run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option) buildkite test this buildkite test this rebuild buildkite test this warnlinkcheck buildkite test this skiplinkcheck

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

Triggering rebuilds You can manually trigger a new Buildkite build with any of the below commands: ``` run docs-build run docs-build rebuild run docs-build warnlinkcheck run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option) buildkite test this buildkite test this rebuild buildkite test this warnlinkcheck buildkite test this skiplinkcheck ```

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

Requesting new docs builds via comments ``` run docs-build run docs-build rebuild run docs-build warnlinkcheck run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option) buildkite test this buildkite test this rebuild buildkite test this warnlinkcheck buildkite test this skiplinkcheck ```

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

Requesting new docs builds via comments 
    run docs-build
    run docs-build rebuild
    run docs-build warnlinkcheck
    run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option)
    buildkite test this
    buildkite test this rebuild
    buildkite test this warnlinkcheck
    buildkite test this skiplinkcheck

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here. Please also be sure to double check all images to ensure they are correct in the preview.

Requesting new docs builds via comments 
    run docs-build
    run docs-build rebuild
    run docs-build warnlinkcheck
    run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option)
    buildkite test this
    buildkite test this rebuild
    buildkite test this warnlinkcheck
    buildkite test this skiplinkcheck

@nkammah
Copy link
Contributor Author

nkammah commented Dec 13, 2023

@jmikell821 this PR rolls-in your change as well as more instructions (see the last comment). I used it to test your change.

@nkammah nkammah marked this pull request as ready for review December 13, 2023 02:24
@nkammah nkammah requested review from a team and scottybollinger December 13, 2023 02:24
@nkammah nkammah mentioned this pull request Dec 13, 2023
Closed
bmorelli25
bmorelli25 reviewed Dec 13, 2023
View reviewed changes
.github/actions/docs-preview/action.yml Outdated
Comment on lines 42 to 49
run docs-build
run docs-build rebuild
run docs-build warnlinkcheck
run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option)
buildkite test this
buildkite test this rebuild
buildkite test this warnlinkcheck
buildkite test this skiplinkcheck
Copy link
Member

Choose a reason for hiding this comment

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

I have a few thoughts here.

  1. Do we need to publicize both versions of the build commands? As I understand it, run docs-build * and buildkite test this * are identical. I think we should pick one set of commands to keep things simple.
  2. I'm not convinced we should publicize the warnlinkcheck and skiplinkcheck options. These really shouldn't be used by most folks as they'll break the doc build if you merge a PR with broken links. These are almost exclusively for members of the docs release team in emergency merge situations.
  3. I think we should explain the difference between run docs-build and run docs-build rebuild.

Copy link
Member

Choose a reason for hiding this comment

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

With that being said. My suggestion would be something like this:

        <details>
            <summary>Request a new doc build by commenting</summary>

            * Rebuild this PR: `run docs-build`
            * Rebuild this PR and all Elastic docs: `run docs-build rebuild`

            > [!NOTE]  
            > `run docs-build` is much faster than `run docs-build rebuild`. A `rebuild` should only be needed in 
            rare situations. If your PR continues to fail for an unknown reason, the doc build pipeline may be 
            broken. Elastic employees can check the pipeline status [here](https://buildkite.com/elastic/docs-build).
          </details>

Is this too much info?

@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.

Help us out by validating the Buildkite preview and reporting issues here.
Please also be sure to double check all images to ensure they are correct in the preview.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@nkammah nkammah merged commit cf002d8 into master Dec 13, 2023
5 of 7 checks passed
@nkammah nkammah deleted the action-update branch December 13, 2023 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmorelli25 bmorelli25 bmorelli25 left review comments

@glitteringkatie glitteringkatie Awaiting requested review from glitteringkatie

@colleenmcginnis colleenmcginnis Awaiting requested review from colleenmcginnis

@kilfoyle kilfoyle Awaiting requested review from kilfoyle

@leemthompo leemthompo Awaiting requested review from leemthompo

@scottybollinger scottybollinger Awaiting requested review from scottybollinger scottybollinger was automatically assigned from elastic/docs-engineering

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nkammah @bmorelli25