docs: extract code samples to shortcodes #2633
Conversation
github-actions
bot
added
the
documentation
✅ Deploy Preview for keptn-lifecycle-toolkit ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mowies
changed the title
|
First of all, you're not up to date with the latest changes on main branch ;) |
|
@mowies , how about now? |
docs/content/en/docs/core-concepts/assets/usecase-orchestrate.md_1.yaml
Outdated
Show resolved
Hide resolved
docs/content/en/docs/getting-started/assets/observability.md_3.yaml
Outdated
Show resolved
Hide resolved
| '-X', | ||
| 'POST', | ||
| 'http://webhook.webhook.svc.cluster.local:8084/YOUR-UUID-HERE', | ||
| '-H', | ||
| 'Content-Type: application/json', | ||
| '-d', | ||
| '{ "from": "keptn send-event" }' | ||
| ] |
There was a problem hiding this comment.
If possible, please increase the indentation
There was a problem hiding this comment.
Hi @odubajDT , what indentation is preferred 2 or 4 spaces?
There was a problem hiding this comment.
in this particular case 2 spaces more, you can find all the details here https://github.com/keptn/lifecycle-toolkit/actions/runs/7111043259/job/19360404602?pr=2633
|
Thank you for your contribution, generally everything looks fine. Can you please adapt the yaml files to make the yamllint check pass? Generally it's mostly newlines or wrong indentation. You can find the results here https://github.com/keptn/lifecycle-toolkit/actions/runs/7097569330/job/19331781969?pr=2633 Thanks! |
ahmedavid
force-pushed
the
feat/extract-shortcodes
branch
2 times, most recently
from
eb985a7 to
faea054
Compare
github-actions
bot
added
ops
scheduler
metrics-operator
cert-manager
lifecycle-operator
and removed
ops
scheduler
metrics-operator
cert-manager
lifecycle-operator
labels
|
Hi @ahmedavid can you please rename the newly created yaml files so that the names will reflect the pages that they are used in and also possibly a use case they are showing? Naming the files with numbers will make it hard in the future to maintain and create connections between docs and resources referenced in the specific parts. Thanks! |
| namespace: simplenode-dev | ||
| evaluationTarget: ">4" | ||
| ``` | ||
| {% include "usecase-orchestrate.md_1.yaml" %} |
There was a problem hiding this comment.
does the include actually work? The resource is located in assets folder, so I guess the path should be assets/usecase-orchestrate.md_1.yaml. You can try it out locally by executing make docs-build && make docs-serve
|
Also I apology for the misunderstanding, but this change should be made in the |
|
Hi, how can I run yaml linter locally? |
Hi |
Hello, formatting issues stem from original files. I can't fix them manually. Is it possible to use some kind of auto formatter? Please recommend one. |
|
Hello @ahmedavid any updates on this please ? |
Hello, yes please refer to previous message |
|
We would recommend this tool https://github.com/cytopia/docker-yamllint What problems do you face exactly ? |
|
Hi @ahmedavid please drop any changes under docs/content/en/docs these folders will be deleted soon and do not require changes, only the docs-new path does. Also make sure to rebase the changes from main to resolve current conflicts. |
ahmedavid
force-pushed
the
feat/extract-shortcodes
branch
from
68942a7 to
9ee4583
Compare
Signed-off-by: David Ahmadov <[email protected]>
|
|
Please retry analysis of this Pull-Request directly on SonarCloud |
| '{ "from": "keptn send-event" }' | ||
| ] | ||
| ``` | ||
| {% include "./assets/lifecycle-management.md_1.yaml" %} |
There was a problem hiding this comment.
All the includes should be in with the backticks, see here for example
|
Hi @ahmedavid can you please resolve the conflicts and adapt the docs according to this comment? Thank you! |
|
This PR is opened for 3 weeks without any activity, closing it and unassigning the author from the ticket. If you would like to continue, please feel free to open a new PR! |
Description
Extract code samples to shortcodes
Fixes #2587