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

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

Check docs are up to date #467

ErikSchierboom opened this issue Aug 20, 2021 · 2 comments · Fixed by #468
Labels
x:action/improve Improve existing functionality/content x:knowledge/none No existing Exercism knowledge required x:size/small Small amount of work 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...........77
✅ Successful......74
⏳ Timeouts.........2
🔀 Redirected.......0
👻 Excluded.........0
🚫 Errors...........1

Errors in ./exercises/practice/hello-world/GETTING_STARTED_GUIDE.md
⧖ http://edn.embarcadero.com/article/10280
✗ http://www.sun.com/workshop/java/wp-coding (HTTP status client error (400 Bad Request) for url (http://www.sun.com/workshop/java/wp-coding))

Errors in ./docs/ABOUT.md
⧖ https://edn.embarcadero.com/article/20396

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
@rpottsoh
Copy link
Member

@ErikSchierboom I am looking into the issues reported. Only one link appears to be in error and I am removing that one from GETTING_STARTED_GUIDE.md. The two flagged as Timeouts do actually work, but took a little longer to load, I have no control over that. Do all the links need to be green?

rpottsoh added a commit to rpottsoh/exercism-delphi that referenced this issue Aug 22, 2021
rpottsoh added a commit to rpottsoh/exercism-delphi that referenced this issue Aug 22, 2021
@ErikSchierboom
Copy link
Member Author

@rpottsoh Not at all. What you've done is great.

rpottsoh added a commit that referenced this issue Aug 24, 2021
Resolves exercism/delphi/#467
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:type/content Work on content (e.g. exercises, concepts)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants