Skip to content

Conversation

georgewallace
Copy link
Contributor

Validating samples across elasticsearch and marking samples as reviewed.

Copy link
Contributor

github-actions bot commented Nov 7, 2024

Documentation preview:

@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v9.0.0 labels Nov 7, 2024
@georgewallace georgewallace added >docs General docs changes Team:Docs Meta label for docs team labels Nov 7, 2024
@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Nov 7, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@georgewallace
Copy link
Contributor Author

@leemthompo
Copy link
Contributor

Two things strike me here:

  • we shouldn't need to manually verify anything that is already explicitly tested
  • where possible, adding tests would be more sustainable than verifying manually

@georgewallace
Copy link
Contributor Author

@leemthompo Agreed. We are only spot checking the top 20 articles. I added the comments to all examples, not just the untested examples, because I tested all of them. I am ok to not put the comments in and just review each of the 20 articles. That might be best. the plan is to automate this for all the rest. But wanted to fix the top 20 articles.

@leemthompo
Copy link
Contributor

Roger that @georgewallace! You can definitely assign a couple of these to writers too :)

@georgewallace
Copy link
Contributor Author

They are all under https://github.com/elastic/platform-docs-team/issues/527. Happy to assign some out, but know everyone is busy.

@georgewallace
Copy link
Contributor Author

@leemthompo I was thinking and I will just close this PR. After thinking about it, we can think about comment automation when testing examples or another way to do it, but for now it would only show on 20 of the pages across the repo which doesn't make sense. Thanks for the feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes Team:Docs Meta label for docs team v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants