docs: updating freight aliases #2606
Conversation
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
✅ Deploy Preview for docs-kargo-akuity-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2606 +/- ##
==========================================
- Coverage 51.09% 50.01% -1.08%
==========================================
Files 282 274 -8
Lines 20961 24386 +3425
==========================================
+ Hits 10709 12197 +1488
- Misses 9584 11539 +1955
+ Partials 668 650 -18 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
|
Nice catch. One comment about formatting and then LGMT. |
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
✅ Deploy Preview for docs-kargo-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@krancour can we merge this PR |
docs/docs/15-concepts.md
Outdated
| @@ -45,6 +45,8 @@ include one or more: | |||
|
|
|||
| Freight can therefore be thought of as a sort of meta-artifact. Freight is what | |||
| Kargo seeks to progress from one stage to another. | |||
| For detailed guidance on working with Freight, refer to | |||
| [this guide](https://kargo.akuity.io/how-to-guides/working-with-freight). | |||
There was a problem hiding this comment.
Putting domain names in a link makes it harder to move the site if/when we need to. (And we just recently did, so it's a thing that can/does happen.)
Just link to pages using file paths instead and Docusaurus will work out the rest:
| [this guide](https://kargo.akuity.io/how-to-guides/working-with-freight). | |
| [this guide](./30-how-to-guides/15-working-with-freight.md). |
There was a problem hiding this comment.
Also, I'm fine with you adding this here, but doing so may cause people to overlook the section on the Freight CRD that is farther down on this page, so consider following up on this PR very soon to merge any useful parts of that section into the "Working with Freight" page. Eventually, the CRD sections of the concepts doc can then be removed, as well discussed yesterday.
This isn't blocking this PR. Just please do not lose track of this follow-up.
There was a problem hiding this comment.
Yes, I have noted in my documentation tracker that the key concepts guide needs to be improved. This will be looked at soon.
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
Signed-off-by: Faeka Ansari <faeka6@gmail.com> (cherry picked from commit f8179dc)
|
Successfully created backport PR for |
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
Addressed an inconsistency in the Kargo documentation related to updating aliases for Freight resources.
Before
After