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

Correct Markdown Links #435

Closed
adhilto opened this issue Sep 25, 2024 · 1 comment · Fixed by #437
Closed

Correct Markdown Links #435

adhilto opened this issue Sep 25, 2024 · 1 comment · Fixed by #437
Assignees
Labels
Baseline Revision documentation This issue or pull request improves or adds to documentation
Milestone

Comments

@adhilto
Copy link
Collaborator

adhilto commented Sep 25, 2024

🐛 Summary

While working on #352, I found a few links that new correction:

As of ScubaGoggles v0.3.0, the minimum required Python version to run the tool is `3.10.x`. While it's possible that ScubaGoggles may work with different versions of Python, 3.10 is the version we've tested and ensured works with the versions of the modules listed in ScubaGoggles' [dependencies](requirements.txt).

The correct link is [dependencies](/requirements.txt).

https://github.com/cisagov/ScubaGoggles/blob/main/docs/prerequisites/CreateAProject.md
That file contains a bad anchor link...but that file itself shouldn't actually exist and should be deleted.

See [GWS.GMAIL.4.1v0.3](#gwsgmail41v02-instructions) instructions for an overview of how to publish and check a DMARC record. Ensure the record published includes `p=reject`.

The correct link is [GWS.GMAIL.4.1v0.3](#gwsgmail41v03-instructions)

See [GWS.GMAIL.4.1v0.3](#gwsgmail41v02-instructions) instructions for an overview of how to publish and check a DMARC record. Ensure the record published includes [email protected] as one of the emails for the `rua` field.

The correct link is [GWS.GMAIL.4.1v0.3](#gwsgmail41v03-instructions)

See [GWS.GMAIL.4.1v0.3](#gwsgmail41v02-instructions) instructions for an overview of how to publish and check a DMARC record. Ensure the record published includes a point of contact specific to your agency, in addition to [email protected], as one of the emails for the `rua` field and one or more agency-defined points of contact for the `ruf` field.

The correct link is [GWS.GMAIL.4.1v0.3](#gwsgmail41v03-instructions)

To reproduce

Click on those links.

Expected behavior

The links should all work.

@adhilto adhilto added documentation This issue or pull request improves or adds to documentation Baseline Revision labels Sep 25, 2024
@snarve snarve added this to the Coast milestone Sep 26, 2024
@mdueltgen
Copy link
Collaborator

https://github.com/cisagov/ScubaGoggles/blob/main/docs/prerequisites/CreateAProject.md
That file contains a bad anchor link...but that file itself shouldn't actually exist and should be deleted.

For this comment @adhilto . Are you saying the link for Authentication hyperlink shouldn't go anywhere? Or do you want it to go here https://github.com/cisagov/ScubaGoggles/blob/main/docs/authentication/AuthenticationMethods.md?

@mdueltgen mdueltgen linked a pull request Sep 30, 2024 that will close this issue
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Baseline Revision documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants