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

2 broken links; commas, and other typos. #313

Merged
merged 1 commit into from
Jul 18, 2024

Conversation

e-io
Copy link
Contributor

@e-io e-io commented Jul 14, 2024

Sprints @EuroPython 2024

@e-io
Copy link
Contributor Author

e-io commented Jul 14, 2024

Also I've checked now falcon.readthedocs.io for broken links. Overall it's quite good. Two broken links were found only.

On the page https://falcon.readthedocs.io/en/stable/_modules/index.html :

  • the first link _asyncio does not work.

On the page https://falcon.readthedocs.io/en/stable/user/tutorial-asgi.html :

I may remove them as well if needed.

Screenshot 2024-07-14 at 18 32 49

The check was performed with this wonderful tool:
https://github.com/stevenvachon/broken-link-checker (blc -ro <a-website-with-links>)

@e-io
Copy link
Contributor Author

e-io commented Jul 14, 2024

With a tool mentioned above I have carefully tidied up all the Falcon Wiki as well. However, most pages had just 2-5 links to fix.

Screenshot 2024-07-14 at 20 08 09

@CaselIT
Copy link
Member

CaselIT commented Jul 17, 2024

that tool seems very useful! tanks for linking it.

I'll try looking at this and the other links asap (I'm very busy this week sadly)

thank you for the effort!

@vytas7
Copy link
Member

vytas7 commented Jul 17, 2024

Thanks for the effort, I'll try to fix the links in the main repo. IIRC Hypercorn was moved from Gitlab to GitHub, hence the issue.
Regarding Wiki, ideally we shouldn't try just removing them, but finding if they have been relocated or pasted wrong. For instance, the Documatt blog link is still there, maybe we just need to get a different permalink.

Edit: I see you actually fixed the Documatt one 👍

Copy link
Member

@vytas7 vytas7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks a lot! 💯 I really like the attention to the details.
We are planning on rebuilding the website using some kind of generator like Sphinx, MkDocs, etc in order to reduce the maintenance burden, but we'll probably still keep a fair bit of content, so your work wouldn't be lost.

Edit: and I heard from @CaselIT that you attended our sprint on Sunday. Unfortunately I had to leave in the morning so I didn't meet you in person (but maybe I saw your face in the conference 🙂 ).

Edit2: Created a PR for Falcon itself: falconry/falcon#2252.

@vytas7 vytas7 merged commit 3ed6d7e into falconry:master Jul 18, 2024
1 check passed
@@ -99,7 +93,7 @@ <h1 class="block-title display-1">Falcon</h1>
<p>
<a href="https://www.kontrolnaya-rabota.ru/s/" target="_blank"><img src="img/sponsors/rabota.jpg" height="30" alt="Examination RU" style="margin-right: 10px"></a>

<a href="https://www.pnk.sh/python-falcon" target="_blank"><img src="img/sponsors/paris.svg" height="30" alt="Paris Kejser" style="margin-right: 10px"></a>
<a href="www.youtube.com/c/ParisNakitaKejser" target="_blank"><img src="img/sponsors/paris.svg" height="30" alt="Paris Kejser" style="margin-right: 10px"></a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, we missed the scheme there. I'll fix it.

@e-io
Copy link
Contributor Author

e-io commented Jul 20, 2024

@vytas7

"Regarding Wiki, ideally we shouldn't try just removing them, but finding if they have been relocated or pasted wrong."

As for links in "Who's using Falcon?":

Initially I was trying to find new links of these projects, but, then, I found that most of them don't exist anymore. Even if any project might exist with a new web address, there is no guarantee that it is still based on Falcon. Or it might be another project with identical name.

Anyway, I hope that the remaining list "Who's using Falcon?" is still enough huge :)

As for links in other pages, I was checking all of them quite carefully.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants