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 more detail about generated docs to the contributors guide #35386

Merged
merged 2 commits into from
May 10, 2023
Merged

Add more detail about generated docs to the contributors guide #35386

merged 2 commits into from
May 10, 2023

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented May 9, 2023 •
edited
Loading

What does this PR do?

Add more detail about contributing to docs.

Why is it important?

Contributors need more guidance on where source files are located and when to run make update. I've tried to strike the balance of providing enough info to be helpful, but not confusing. Getting into the gnarly bits of our content reuse strategy would be too much detail, IMO, so I've left that out.

Checklist

  • My code follows the style guidelines of this project

Related issues

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label May 9, 2023
@mergify
Copy link
Contributor

mergify bot commented May 9, 2023

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @dedemorton? 🙏.
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

@dedemorton dedemorton added the Team:Docs Label for the Observability docs team label May 9, 2023
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label May 9, 2023
@elasticmachine
Copy link
Collaborator

elasticmachine commented May 9, 2023 •
edited by jenkins-beats-ci bot
Loading

💚 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-05-10T00:51:47.646+0000

  • Duration: 8 min 53 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 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!)

@dedemorton dedemorton marked this pull request as ready for review May 10, 2023 00:51
@dedemorton dedemorton requested a review from a team as a code owner May 10, 2023 00:51
@elasticmachine
Copy link
Collaborator

Pinging @elastic/ingest-docs (Team:Docs)

@dedemorton dedemorton requested a review from a team May 10, 2023 00:52
@dedemorton dedemorton changed the title [WIP]Add more detail about generated docs to the contributors guide Add more detail about generated docs to the contributors guide May 10, 2023
cmacknz
cmacknz approved these changes May 10, 2023
View reviewed changes
Copy link
Member

@cmacknz cmacknz left a comment

Choose a reason for hiding this comment

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

Looks great!

kilfoyle
kilfoyle approved these changes May 10, 2023
View reviewed changes
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

Really nice additions, DeDe!

karenzone
karenzone approved these changes May 10, 2023
View reviewed changes
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

Thank you, DeDe. LGTM

@dedemorton dedemorton added backport-7.17 Automated backport to the 7.17 branch with mergify backport-v8.7.0 Automated backport with mergify backport-v8.8.0 Automated backport with mergify labels May 10, 2023
@dedemorton dedemorton merged commit 0aca373 into elastic:main May 10, 2023
@dedemorton dedemorton deleted the obs-docs-projects#76 branch May 10, 2023 21:55
mergify bot pushed a commit that referenced this pull request May 10, 2023
@dedemorton @mergify
Add more detail about generated docs to the contributors guide (#35386)
c8a445e 
(cherry picked from commit 0aca373)

# Conflicts:
#	docs/devguide/contributing.asciidoc
#	docs/devguide/index.asciidoc
mergify bot pushed a commit that referenced this pull request May 10, 2023
@dedemorton @mergify
Add more detail about generated docs to the contributors guide (#35386)
8400879 
(cherry picked from commit 0aca373)
mergify bot pushed a commit that referenced this pull request May 10, 2023
@dedemorton @mergify
Add more detail about generated docs to the contributors guide (#35386)
ddd0a02 
(cherry picked from commit 0aca373)
This was referenced May 10, 2023
Closed
Merged
@mergify mergify bot mentioned this pull request May 10, 2023
Merged
dedemorton added a commit that referenced this pull request May 11, 2023
@mergify @dedemorton
Add more detail about generated docs to the contributors guide (#35386)…
3edf96b 
… (#35422)

(cherry picked from commit 0aca373)

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
dedemorton added a commit that referenced this pull request May 11, 2023
@mergify @dedemorton
Add more detail about generated docs to the contributors guide (#35386)…
19d035e 
… (#35421)

(cherry picked from commit 0aca373)

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@dedemorton dedemorton removed the backport-7.17 Automated backport to the 7.17 branch with mergify label May 11, 2023
chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023
@dedemorton @chrisberkhout
Add more detail about generated docs to the contributors guide (#35386)
5b7c0c8
@reakaleek reakaleek mentioned this pull request Jul 19, 2023
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cmacknz cmacknz cmacknz approved these changes

@karenzone karenzone karenzone approved these changes

@kilfoyle kilfoyle kilfoyle approved these changes

@ycombinator ycombinator Awaiting requested review from ycombinator ycombinator is a code owner automatically assigned from elastic/elastic-agent-data-plane

@faec faec Awaiting requested review from faec faec is a code owner automatically assigned from elastic/elastic-agent-data-plane

Assignees

@dedemorton dedemorton

Labels
backport-v8.7.0 Automated backport with mergify backport-v8.8.0 Automated backport with mergify docs Team:Docs Label for the Observability docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@dedemorton @elasticmachine @cmacknz @karenzone @kilfoyle