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

[docs]: update references in READMEs #3486

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[docs]: update references in READMEs #3486

wants to merge 3 commits into from

Conversation

mtoffl01
Copy link
Contributor

@mtoffl01 mtoffl01 commented Nov 18, 2024

Motivation

References to some docs in various READMEs were either missing or incorrect

Changes

  • Fixes link to scenarios documentation in root README
  • Removes reference to since-deleted doc lifecycle.md in edit/README
  • Adds reference to previously-overlooked docs remote-config.md, update-docker-images.md and CI-and-scenarios.md in edit/README

Workflow

  1. ⚠️ Create your PR as draft ⚠️
  2. Work on you PR until the CI passes (if something not related to your task is failing, you can ignore it)
  3. Mark it as ready for review
    • Test logic is modified? -> Get a review from RFC owner. We're working on refining the codeowners file quickly.
    • Framework is modified, or non obvious usage of it -> get a review from R&P team

🚀 Once your PR is reviewed, you can merge it!

🛟 #apm-shared-testing 🛟

Reviewer checklist

  • If PR title starts with [<language>], double-check that only <language> is impacted by the change
  • No system-tests internal is modified. Otherwise, I have the approval from R&P team
  • CI is green, or failing jobs are not related to this change (and you are 100% sure about this statement)
  • A docker base image is modified?
    • the relevant build-XXX-image label is present
  • A scenario is added (or removed)?

@mtoffl01 mtoffl01 requested a review from a team as a code owner November 18, 2024 19:14
@mtoffl01 mtoffl01 changed the title [docs]: remove reference to deleted doc in edit/README.md [docs]: update index in edit/README.md Nov 18, 2024
@mtoffl01 mtoffl01 marked this pull request as draft November 18, 2024 19:15
@mtoffl01 mtoffl01 marked this pull request as ready for review November 18, 2024 19:19
@mtoffl01 mtoffl01 changed the title [docs]: update index in edit/README.md [docs]: update references in READMEs Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant