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

Docs: Relocate alpha_k8s_apis to configuration sections across docs #2082

Merged
merged 1 commit into from
Jul 9, 2024
Merged

Docs: Relocate alpha_k8s_apis to configuration sections across docs #2082

merged 1 commit into from
Jul 9, 2024

Conversation

svteb
Copy link
Collaborator

@svteb svteb commented Jun 21, 2024 •
edited
Loading

Description

Should move all k8s API related stuff to the correct configuration sections across doc files.

Interestingly there were as of yet unimplemented TO DO'S in USAGE.md and TEST_CATEGORIES.md which were also moved for future coherence (these relate to the k8s APIs category).

Issues:

Refs: #2077

How has this been tested:

  • Covered by existing integration testing
  • Added integration testing to cover
  • Verified all A/C passes
    • develop
    • master
    • tag/other branch
  • Test environment
    • Shared Packet K8s cluster
    • New Packet K8s cluster
    • Kind cluster
  • Have not tested

Types of changes:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist:

Documentation

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • No updates required.

Code Review

  • Does the test handle fatal exceptions, ie. rescue block

Issue

  • Tasks in issue are checked off

@svteb
Copy link
Collaborator Author

svteb commented Jun 21, 2024

I am not sure if I covered all the doc files, if I missed something write a comment.

@martin-mat
Copy link
Collaborator

@svteb please rebase and adapt to the new doc structure

@svteb
Copy link
Collaborator Author

svteb commented Jun 27, 2024 •
edited
Loading

I will rebase after #2089 is merged to avoid some issues.

@kosstennbl
Copy link
Collaborator

Can be rebased now

@kosstennbl
Copy link
Collaborator

It seems that for alpha_k8s_apis test in current documentation - can be quite easily moved (in docs and TOC).
TODOs are a different problem, they can be somehow represented in description of configuration test (they were lost during transfer to new docs)

@svteb svteb force-pushed the alpha_k8s_apis_relocation branch from 448f694 to 07409a1 Compare July 8, 2024 08:40
@svteb
Docs: Relocate alpha_k8s_apis to configuration sections across docs
7649d91 
Refs: cnti-testcatalog#2077
- Interestingly there were as of yet unimplemented TO DO'S in USAGE.md
and TEST_CATEGORIES.md which were also moved for future coherence (these
relate to the k8s APIs category).

Signed-off-by: svteb <[email protected]>
@svteb svteb force-pushed the alpha_k8s_apis_relocation branch from 07409a1 to 7649d91 Compare July 8, 2024 09:00
kosstennbl
kosstennbl approved these changes Jul 9, 2024
View reviewed changes
Copy link
Collaborator

@kosstennbl kosstennbl left a comment

Choose a reason for hiding this comment

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

LGTM

rich-l
rich-l approved these changes Jul 9, 2024
View reviewed changes
Copy link

@rich-l rich-l left a comment

Choose a reason for hiding this comment

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

lgtm

Smitholi67
Smitholi67 approved these changes Jul 9, 2024
View reviewed changes
Copy link
Collaborator

@Smitholi67 Smitholi67 left a comment

Choose a reason for hiding this comment

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

lgtm

@martin-mat martin-mat merged commit 53554ed into cnti-testcatalog:main Jul 9, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Smitholi67 Smitholi67 Smitholi67 approved these changes

@rich-l rich-l rich-l approved these changes

@collivier collivier collivier approved these changes

@denverwilliams denverwilliams Awaiting requested review from denverwilliams

@agentpoyo agentpoyo Awaiting requested review from agentpoyo

@martin-mat martin-mat Awaiting requested review from martin-mat

@taylor taylor Awaiting requested review from taylor

@kosstennbl kosstennbl Awaiting requested review from kosstennbl

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

Successfully merging this pull request may close these issues.
6 participants
@svteb @martin-mat @kosstennbl @collivier @rich-l @Smitholi67