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.

Sign up for GitHub

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

Jump to bottom

docs(site): bad link in zarf tutorial - Creating a Zarf Package #2643

Closed
joelmccoy opened this issue Jun 20, 2024 · 1 comment
Closed

docs(site): bad link in zarf tutorial - Creating a Zarf Package #2643

joelmccoy opened this issue Jun 20, 2024 · 1 comment
Assignees
@AustinAbro321

Comments

@joelmccoy
Copy link
Contributor

Link on this site is broken

image
what happens to resources that exist before Zarf init

Takes you to an invalid FAQ. As a new user I was trying to figure out what happens to preexisting resources and there doesn't seem to be an FAQ for this.

Potential Fixes:

  1. Add in an FAQ and fix this link
  2. Or point to another page for this info (but I couldn't directly find this, the best I found was here and it doesn't really answer what happens to preexisting resources directly)
  3. Remove this note all together so there is less confusion

PS: I've been going through some Zarf documentation and tutorials as a new member of Defense Unicorns. I am finding some broken links/things that could be cleaned up as I go along. If there is a better feedback mechanism other than opening a github issue let me know.
@AustinAbro321 AustinAbro321 mentioned this issue Jun 20, 2024
Closed
@AustinAbro321
Copy link
Contributor

Really appreciate you looking through. Issues are good, we should also have a link checker in CI to ensure we're not using any broken links. Made an issue for that #2649

@AustinAbro321 AustinAbro321 self-assigned this Jun 20, 2024
@AustinAbro321 AustinAbro321 mentioned this issue Jun 20, 2024
Merged
2 tasks
AustinAbro321 added a commit that referenced this issue Jun 21, 2024
@AustinAbro321
fix: docs links (#2650)
eab8a98 
## Description

Fixes all the links checked by linkinator. Not checking github since it
gives bad error codes even if the site link works

## Related Issue

Fixes #2642 and #2643

## Checklist before merging

- [ ] Test, docs, adr added or updated as needed
- [ ] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/.github/CONTRIBUTING.md#developer-workflow)
followed
AustinAbro321 added a commit that referenced this issue Jul 23, 2024
@AustinAbro321
fix: docs links (#2650)
598bc51 
## Description

Fixes all the links checked by linkinator. Not checking github since it
gives bad error codes even if the site link works

## Related Issue

Fixes #2642 and #2643

## Checklist before merging

- [ ] Test, docs, adr added or updated as needed
- [ ] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/.github/CONTRIBUTING.md#developer-workflow)
followed

Signed-off-by: Austin Abro <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AustinAbro321 AustinAbro321

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@joelmccoy @AustinAbro321