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.

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

Add doc-site-branch to version.asciidoc #35693

Merged
merged 3 commits into from
Jun 9, 2023
Merged

Add doc-site-branch to version.asciidoc #35693

merged 3 commits into from
Jun 9, 2023

Conversation

AndersonQ
Copy link
Member

What does this PR do?

Fixes the docs for the main branch

Why is it important?

Because the links on elastic.co are broken:

doesn't work: https://www.elastic.co/guide/en/beats/metricbeat/main/metricbeat-module-consul.html
works: https://www.elastic.co/guide/en/beats/metricbeat/master/metricbeat-module-consul.html

Checklist

  • [ ] My code follows the style guidelines of this project
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • [ ] I have made corresponding change to the default configuration files
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

How to test this PR locally

N/A

Related issues

N/A

@AndersonQ AndersonQ added docs Team:Elastic-Agent Label for the Agent team labels Jun 6, 2023
@AndersonQ AndersonQ requested a review from a team as a code owner June 6, 2023 08:13
@AndersonQ AndersonQ self-assigned this Jun 6, 2023
@AndersonQ AndersonQ requested review from ycombinator and belimawr June 6, 2023 08:13
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent (Team:Elastic-Agent)

@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Jun 6, 2023
@mergify
Copy link
Contributor

mergify bot commented Jun 6, 2023

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @AndersonQ? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

@elasticmachine
Copy link
Collaborator

elasticmachine commented Jun 6, 2023

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-06-08T15:35:51.094+0000

  • Duration: 69 min 36 sec

Test stats 🧪

Test Results
Failed 0
Passed 27333
Skipped 2009
Total 29342

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

Copy link
Contributor

@ycombinator ycombinator left a comment

Choose a reason for hiding this comment

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

Is this change enough? Does there need to be another change where doc-site-branch is used?

For example, in the Agent repo, doc-site-branch is set over here: https://github.com/elastic/elastic-agent/blob/409682e5efba99f6b4ff034a503b1d0827a67b0b/version/docs/version.asciidoc#L5

And then it is used over here: https://github.com/elastic/elastic-agent/blob/409682e5efba99f6b4ff034a503b1d0827a67b0b/dev-tools/mage/settings.go#L379

@AndersonQ AndersonQ merged commit 25adc03 into main Jun 9, 2023
@AndersonQ AndersonQ deleted the fix-docs-link branch June 9, 2023 09:56
AndersonQ added a commit to AndersonQ/beats that referenced this pull request Jun 12, 2023
@AndersonQ AndersonQ mentioned this pull request Jun 12, 2023
1 task
AndersonQ added a commit that referenced this pull request Jun 13, 2023
* Revert "add doc-site-branch to version.asciidoc and settings.go (#35693)"

This reverts commit 25adc03.

* revert to use 'master' on Docs links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Team:Elastic-Agent Label for the Agent team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants