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

Fix typo and style issues in lmp-customization #712

Merged
merged 1 commit into from
Jun 12, 2024

Conversation

kprosise
Copy link
Contributor

Addressed issues to more closely adhere to the style-guide.

Checked rendered output, and ran linter. No issues to report.

No associated ticket, minor fix.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@kprosise kprosise requested review from vanmaegima and a team June 12, 2024 10:26
@doanac
Copy link
Member

doanac commented Jun 12, 2024

worker_tag: "amd64-partner-aws"
params:
IMAGE: lmp-factory-image
SSTATE_CACHE_MIRROR: ""
Copy link
Member

Choose a reason for hiding this comment

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

This SSTATE_CACHE_MIRROR line can be removed because it is not more in use

Copy link
Member

Choose a reason for hiding this comment

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

not related with this PR but there are another reference for it that we can also erase
https://github.com/search?q=repo%3Afoundriesio%2Fdocs%20SSTATE_CACHE_MIRROR&type=code

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@quaresmajose do you know when it became deprecated? I want to see what I can come up with to help ensure these types of changes get reflected in the docs.

Copy link
Member

Choose a reason for hiding this comment

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

It was deprecated since Nov 27, 2023 with the merge of foundriesio/ci-scripts#314.
There is no side effect of continuing to have this variable defined. it is simply ignored

Copy link
Member

Choose a reason for hiding this comment

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

I'm sorry but it was actually my fault and I should also remove this from the documentation

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I got it, no worries!

@doanac
Copy link
Member

doanac commented Jun 12, 2024

kprosise added a commit to kprosise/docs that referenced this pull request Jun 12, 2024
This commit removes 1 of 2 reference, with the other being included in
PR foundriesio#712.

QA Steps: Checked rendered output, no issues seen.

No related ticket, small fix.

Signed-off-by: Katrina Prosise <[email protected]>
Addressed issues to more closely adhere to the style-guide.

Checked rendered output, and ran linter. No issues to report.

No associated ticket, minor fix.

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise force-pushed the typo-fixes-lmp-customization branch from cd6f7dd to b9c09a9 Compare June 12, 2024 12:07
@doanac
Copy link
Member

doanac commented Jun 12, 2024

@kprosise kprosise merged commit 2847d64 into foundriesio:main Jun 12, 2024
1 of 3 checks passed
@kprosise kprosise deleted the typo-fixes-lmp-customization branch June 12, 2024 12:12
kprosise added a commit that referenced this pull request Jun 12, 2024
This commit removes 1 of 2 reference, with the other being included in
PR #712.

QA Steps: Checked rendered output, no issues seen.

No related ticket, small fix.

Signed-off-by: Katrina Prosise <[email protected]>
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.

4 participants