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

update artifactory docs #347

Merged
merged 10 commits into from
Oct 1, 2024
Merged

Conversation

JoshuaGlassKainos
Copy link
Contributor

@JoshuaGlassKainos JoshuaGlassKainos commented Sep 25, 2024

Jira link

https://tools.hmcts.net/jira/browse/DTSPO-18735

Change description

  • removed previous code examples
  • updated documentation to accommodate helm setup
  • added new code blocks
  • added new troubleshooting steps
  • update example apps overview in patching-aks-apps.html

Checklist

  • commit messages are meaningful and follow good commit message guidelines
  • README and other documentation has been updated / added (if needed)
  • tests have been updated / new tests has been added (if needed)
  • Does this PR introduce a breaking change

source/aks/patching-artifactory.html.md.erb Show resolved Hide resolved
source/aks/patching-artifactory.html.md.erb Outdated Show resolved Hide resolved
source/aks/patching-artifactory.html.md.erb Outdated Show resolved Hide resolved
source/aks/patching-artifactory.html.md.erb Outdated Show resolved Hide resolved
source/aks/patching-artifactory.html.md.erb Show resolved Hide resolved
Copy link

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (5)

jfmd
jfrou
jfrt
pvc
statefulset

To accept these unrecognized words as correct, you could run the following commands

... in a clone of the [email protected]:hmcts/ops-runbooks.git repository
on the artifactory/update-patching-docs branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/hmcts/ops-runbooks/actions/runs/11103148518/attempts/1'
Warnings (1)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

ℹ️ Warnings Count
ℹ️ no-newline-at-eof 1

See ℹ️ Event descriptions for more information.


🖊️ Please consider adding a word to the allow list if it is flagged as a spelling error but is genuinely used within the project.
🤔 Think we might see a flagged mistake in another PR in the future? Please consider adding it as an expected pattern


[Artifactory Release Information](https://jfrog.com/help/r/jfrog-release-information/artifactory-release-notes)

## Troubleshooting
Copy link
Contributor

Choose a reason for hiding this comment

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

Would love a little paragraph here about how you got to the errors please, to make things a bit clearer at the beginning

What commands can you use to troubleshoot?
How does the pod set up with different containers work - should I always get logs against the default pod? etc

Copy link
Contributor Author

Choose a reason for hiding this comment

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

May need more addition after I add my updates, see if there's anything else more we can add / refine

Copy link
Contributor

@reespozzi reespozzi left a comment

Choose a reason for hiding this comment

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

LGTM - would you mind also adding as a link in this table please https://hmcts.github.io/ops-runbooks/aks/patching-aks-apps.html#application-specific-examples

@JoshuaGlassKainos JoshuaGlassKainos changed the title wip, update artifactory docs update artifactory docs Oct 1, 2024
@JoshuaGlassKainos JoshuaGlassKainos marked this pull request as ready for review October 1, 2024 11:23
@JoshuaGlassKainos JoshuaGlassKainos requested a review from a team as a code owner October 1, 2024 11:23
@JoshuaGlassKainos JoshuaGlassKainos requested review from louisehuyton, Johns293 and cpareek and removed request for a team October 1, 2024 11:23
@JoshuaGlassKainos JoshuaGlassKainos merged commit 4aded7a into main Oct 1, 2024
2 checks passed
@JoshuaGlassKainos JoshuaGlassKainos deleted the artifactory/update-patching-docs branch October 1, 2024 11:24
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.

2 participants