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

Check docs are up to date #850

Closed
ErikSchierboom opened this issue Aug 20, 2021 · 2 comments · Fixed by #845
Closed

Check docs are up to date #850

ErikSchierboom opened this issue Aug 20, 2021 · 2 comments · Fixed by #845
Labels
x:action/improve Improve existing functionality/content x:knowledge/none No existing Exercism knowledge required x:size/small Small amount of work x:status/claimed Someone is working on this issue x:type/content Work on content (e.g. exercises, concepts)

Comments

@ErikSchierboom
Copy link
Member

ErikSchierboom commented Aug 20, 2021

Please check if your documentation files are still up-to-date.

The key documentation files to check are:

  • docs/ABOUT.md
  • docs/INSTALLATION.md
  • docs/LEARNING.md
  • docs/RESOURCES.md
  • docs/TESTS.md
  • exercises/shared/.docs/help.md
  • exercises/shared/.docs/tests.md

There might be more.

Link check report

To help identify invalid links, we've automatically checked the links of all *.md files in this repo.
This is the report of that check:

📝 Summary
---------------------
🔍 Total..........751
✅ Successful.....744
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
🚫 Errors...........7

Errors in ./reference/exercise-concepts/bank-account.md
✗ https://exercism.io/tracks/elixir/exercises/bank-account/solutions/961596ab0cce445aa918452137feae1b (HTTP status client error (404 Not Found) for url (https://exercism.io/tracks/elixir/exercises/bank-account/solutions/961596ab0cce445aa918452137feae1b))

Errors in ./docs/TESTS.md
✗ http://elixir-lang.org/docs/stable/elixir/typespecs.html (HTTP status client error (404 Not Found) for url (https://elixir-lang.org/docs/stable/elixir/typespecs.html))

Errors in ./HELLO.md
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir+repo%3Aexercism%2Felixir-test-runner+repo%3Aexercism%2Felixir-representer+repo%3Aexercism%2Felixir-analyzer (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir+repo%3Aexercism%2Felixir-test-runner+repo%3Aexercism%2Felixir-representer+repo%3Aexercism%2Felixir-analyzer))
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-representer (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-representer))
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir))
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-analyzer (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-analyzer))
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-test-runner (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-test-runner))

Tracking

exercism/v3-launch#54

@ErikSchierboom ErikSchierboom added x:size/small Small amount of work x:type/content Work on content (e.g. exercises, concepts) x:knowledge/none No existing Exercism knowledge required x:action/improve Improve existing functionality/content labels Aug 20, 2021
@angelikatyborska
Copy link
Member

There's a PR already for this: #845 but it doesn't fix that one broken link, I'll look into it

@angelikatyborska angelikatyborska added the x:status/claimed Someone is working on this issue label Aug 20, 2021
@angelikatyborska
Copy link
Member

@ErikSchierboom I think your link checker got some false positives here:

Errors in ./HELLO.md
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir+repo%3Aexercism%2Felixir-test-runner+repo%3Aexercism%2Felixir-representer+repo%3Aexercism%2Felixir-analyzer (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir+repo%3Aexercism%2Felixir-test-runner+repo%3Aexercism%2Felixir-representer+repo%3Aexercism%2Felixir-analyzer))
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-representer (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-representer))
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir))
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-analyzer (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-analyzer))
✗ https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-test-runner (HTTP status client error (404 Not Found) for url (https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-test-runner))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:action/improve Improve existing functionality/content x:knowledge/none No existing Exercism knowledge required x:size/small Small amount of work x:status/claimed Someone is working on this issue x:type/content Work on content (e.g. exercises, concepts)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants