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 #2484

Closed
7 tasks done
ErikSchierboom opened this issue Aug 20, 2021 · 7 comments
Closed
7 tasks done

Check docs are up to date #2484

ErikSchierboom opened this issue Aug 20, 2021 · 7 comments
Assignees
Labels
x:action/improve Improve existing functionality/content x:knowledge/intermediate Quite a bit of Exercism knowledge required x:size/medium Medium 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.........1583
✅ Successful....1574
⏳ Timeouts.........1
🔀 Redirected.......0
👻 Excluded.........0
🚫 Errors...........8

Errors in ./docs/LEARNING.md
⧖ https://www.learnpython.org/

Errors in ./concepts/basics/about.md
✗ https://blog.startifact.com/posts/older/what-is-pythonic.html (error sending request for url (https://blog.startifact.com/posts/older/what-is-pythonic.html): error trying to connect: error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed:ssl/statem/statem_clnt.c:1915: (certificate has expired))

Errors in ./reference/exercise-concepts/matrix.md
✗ https://exercism.io/tracks/python/exercises/matrix/solutions/b6a3486a35c14372b64fdc35e7c6f98f (HTTP status client error (404 Not Found) for url (https://exercism.io/tracks/python/exercises/matrix/solutions/b6a3486a35c14372b64fdc35e7c6f98f))

Errors in ./exercises/concept/guidos-gorgeous-lasagna/.docs/introduction.md
✗ https://blog.startifact.com/posts/older/what-is-pythonic.html (error sending request for url (https://blog.startifact.com/posts/older/what-is-pythonic.html): error trying to connect: error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed:ssl/statem/statem_clnt.c:1915: (certificate has expired))

Errors in ./docs/TESTS.md
✗ https://www.youtube.com/watch?v=P0pIW5tJrRM (HTTP status client error (401 Unauthorized) for url (https://www.youtube.com/oembed?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DP0pIW5tJrRM))

Errors in ./concepts/basics/introduction.md
✗ https://blog.startifact.com/posts/older/what-is-pythonic.html (error sending request for url (https://blog.startifact.com/posts/older/what-is-pythonic.html): error trying to connect: error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed:ssl/statem/statem_clnt.c:1915: (certificate has expired))

Errors in ./exercises/concept/little-sisters-essay/.docs/introduction.md
✗ https://unicode.org/emoji/'.strip('/stph:') (HTTP status client error (404 Not Found) for url (https://unicode.org/emoji/'.strip('/stph:')))

Errors in ./exercises/concept/making-the-grade/.docs/hints.md
✗ https://docs.python.org/3/tutorial/controlflo.html#break-and-continue-statements-and-else-clauses-on-loops (HTTP status client error (404 Not Found) for url (https://docs.python.org/3/tutorial/controlflo.html#break-and-continue-statements-and-else-clauses-on-loops))

Errors in ./reference/concepts/pythonic.md
✗ https://blog.startifact.com/posts/older/what-is-pythonic.html (error sending request for url (https://blog.startifact.com/posts/older/what-is-pythonic.html): error trying to connect: error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed:ssl/statem/statem_clnt.c:1915: (certificate has expired))

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
@BethanyG BethanyG added x:knowledge/intermediate Quite a bit of Exercism knowledge required x:size/medium Medium amount of work and removed x:knowledge/none No existing Exercism knowledge required x:size/small Small amount of work labels Aug 20, 2021
@BethanyG
Copy link
Member

@ErikSchierboom -- Thanks for filing this, and for checking all the links. I am re-flagging this as intermediate knowledge needed, and as size medium. None of these docs are up-to-date with either the latest version of Python nor the latest version of PyTest, so they're going to take a fair amount of work. Going to try to bring them up to date this weekend.

@ErikSchierboom
Copy link
Member Author

@BethanyG Great. Just found out that I didn't actually check all links 🤦 But I'm hitting rate limits if I do 🤷

@ErikSchierboom
Copy link
Member Author

@BethanyG Updated! There might be some false positives, mind.

@BethanyG
Copy link
Member

BethanyG commented Sep 1, 2021

@ErikSchierboom - If you have a moment and can click approve on the linked PRs.... 😁 I think I am FINALLY done with these! 🎉 (of course now there will be issues....).

@ErikSchierboom
Copy link
Member Author

@BethanyG Sure. Just done that. I haven't read any content though :D

@BethanyG
Copy link
Member

BethanyG commented Sep 1, 2021

Oh..you really should read the content. I tell such interesting stories about you! (joking, of course!). Many thanks for the clickty-clicks! 🌟

@ErikSchierboom
Copy link
Member Author

Haha, lol.

@BethanyG BethanyG closed this as completed Sep 1, 2021
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/intermediate Quite a bit of Exercism knowledge required x:size/medium Medium 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

No branches or pull requests

2 participants