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: doc to access OCP endpoint via CIS #385

Merged
merged 30 commits into from
Sep 30, 2023
Merged

docs: doc to access OCP endpoint via CIS #385

merged 30 commits into from
Sep 30, 2023

Conversation

maheshwarishikha
Copy link
Member

@maheshwarishikha maheshwarishikha commented Sep 28, 2023

Description

Issue - https://github.ibm.com/GoldenEye/issues/issues/5390
It adds steps to access api endpoint deployed in OCP via CIS.

Release required?

  • No release
  • Patch release (x.x.X)
  • Minor release (x.X.x)
  • Major release (X.x.x)
Release notes content

Run the pipeline

If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.

Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:

/run pipeline

Checklist for reviewers

  • If relevant, a test for the change is included or updated with this PR.
  • If relevant, documentation for the change is included or updated with this PR.

Merge actions for mergers

  • When merging, use a relevant conventional commit message that is based on the PR contents and any release notes provided by the PR author. The commit message determines whether a new version of the module is needed, and if so, which semver increment to use (major, minor, or patch).
  • Merge by using "Squash and merge".

@maheshwarishikha
Copy link
Member Author

/run pipeline

@maheshwarishikha
Copy link
Member Author

/run pipeline

Copy link
Contributor

@SirSpidey SirSpidey 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 the content that will form the solution tutorial?

If so, we probably don't need it here, but can just point to the public cloud docs tutorial when that's ready (from the main readme or an example readme).

If it's different content, can you help me understand the difference?

access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
@maheshwarishikha
Copy link
Member Author

Is this the content that will form the solution tutorial?

If so, we probably don't need it here, but can just point to the public cloud docs tutorial when that's ready (from the main readme or an example readme).

If it's different content, can you help me understand the difference?

Its a different content. Here we are not talking about SLZ, it is just to close a loop to access any endpoint via CIS. We have taken example of OpenShift. SLZ tutorials will be quite different.

@maheshwarishikha
Copy link
Member Author

/run pipeline

@maheshwarishikha maheshwarishikha requested review from SirSpidey and removed request for jojustin September 29, 2023 12:21
Copy link
Contributor

@SirSpidey SirSpidey left a comment

Choose a reason for hiding this comment

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

Hi @maheshwarishikha. Here are my suggestions to improve the task topic.

  • Start with an H1 in every file, and use sequentially headings
  • Break up the long series of steps with sections (and renumber).
  • Provide and introduction, context to the sections, and a conclusion.
  • Make sure that you have all the prereqs.
  • Check for missing articles (the, a).
  • Add code highlighting to code samples (all shell here).

access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
access-ocp-api-through-cis.md Outdated Show resolved Hide resolved
examples/complete/README.md Outdated Show resolved Hide resolved
@maheshwarishikha
Copy link
Member Author

/run pipeline

Style edits. Should not change the accuracy.
Copy link
Contributor

@SirSpidey SirSpidey left a comment

Choose a reason for hiding this comment

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

Ran this through our style checker and committed changes here. Make sure everything is still accurate.

@maheshwarishikha
Copy link
Member Author

/run pipeline

@jojustin jojustin changed the title doc to access OCP endpoint via CIS docs: doc to access OCP endpoint via CIS Sep 30, 2023
@maheshwarishikha
Copy link
Member Author

/run pipeline

@maheshwarishikha
Copy link
Member Author

/run pipeline

@jojustin jojustin merged commit faca544 into main Sep 30, 2023
@jojustin jojustin deleted the sm-5390 branch September 30, 2023 13:59
@terraform-ibm-modules-ops
Copy link
Contributor

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants