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

Add robots.txt file to doc preview websites for PRs and releases #38694

Merged
merged 1 commit into from
Sep 29, 2024

Conversation

kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Sep 22, 2024

We are experiencing an extraordinary surge of access to the doc preview websites for PRs and releases.
Screenshot 2024-09-22 at 2 24 56 PM
We suspect that it is by web crawlers indexing the websites. This may be a good thing for our doc sites for stable releases, but a threat of excessive use of limited bandwidth (100GB monthly) of our netlify (web publishing service) resource.

Hence we add "robots.txt" file to the websites to discourage web crawlers.

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

@kwankyu kwankyu changed the title Dynamically create robots.txt Add robots.txt file to doc preview websites for PRs and releases Sep 22, 2024
@kwankyu kwankyu marked this pull request as ready for review September 22, 2024 05:32
Copy link

Documentation preview for this PR (built with commit a08bbfb; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Sep 22, 2024

Thanks!

vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 27, 2024
… and releases

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

We are experiencing an extraordinary surge of access to the doc preview
websites for PRs and releases.
<img width="924" alt="Screenshot 2024-09-22 at 2 24 56 PM"
src="https://github.com/user-
attachments/assets/e7d49ae9-b14e-485f-95bf-3dee2d4f3bc6">
We suspect that it is by web crawlers indexing the websites. This may be
a good thing for our doc sites for stable releases, but a threat of
excessive use of limited bandwidth (100GB monthly) of our netlify (web
publishing service) resource.

Hence we add "robots.txt" file to the websites to discourage web
crawlers.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38694
Reported by: Kwankyu Lee
Reviewer(s): Frédéric Chapoton
@vbraun vbraun merged commit aaeb0fa into sagemath:develop Sep 29, 2024
21 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants