Skip to content

Commit

Permalink
Merge branch 'main' into pyup/scheduled-update-2022-05-02
Browse files Browse the repository at this point in the history
  • Loading branch information
humitos authored May 24, 2022
2 parents 4329348 + 1d32da6 commit 4babe55
Show file tree
Hide file tree
Showing 169 changed files with 113,215 additions and 26,902 deletions.
2 changes: 2 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ coverage:
informational: true
codecov:
require_ci_to_pass: false
github_checks:
annotations: false
35 changes: 35 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
Version 8.0.2
-------------

:Date: May 16, 2022

* `@stsewd <https://github.com/stsewd>`__: Fix tests on .com (`#9233 <https://github.com/readthedocs/readthedocs.org/pull/9233>`__)
* `@agjohnson <https://github.com/agjohnson>`__: Disable codecov annotations (`#9186 <https://github.com/readthedocs/readthedocs.org/pull/9186>`__)
* `@choldgraf <https://github.com/choldgraf>`__: Note sub-folders with a single domain. (`#9185 <https://github.com/readthedocs/readthedocs.org/pull/9185>`__)
* `@stsewd <https://github.com/stsewd>`__: BuildCommand: add option to merge or not stderr with stdout (`#9184 <https://github.com/readthedocs/readthedocs.org/pull/9184>`__)
* `@agjohnson <https://github.com/agjohnson>`__: Fix bumpver issue (`#9181 <https://github.com/readthedocs/readthedocs.org/pull/9181>`__)
* `@agjohnson <https://github.com/agjohnson>`__: Release 8.0.1 (`#9180 <https://github.com/readthedocs/readthedocs.org/pull/9180>`__)
* `@agjohnson <https://github.com/agjohnson>`__: Spruce up docs on pull request builds (`#9177 <https://github.com/readthedocs/readthedocs.org/pull/9177>`__)
* `@ericholscher <https://github.com/ericholscher>`__: Fix RTD branding in the code (`#9175 <https://github.com/readthedocs/readthedocs.org/pull/9175>`__)
* `@agjohnson <https://github.com/agjohnson>`__: Fix copy issues on model fields (`#9170 <https://github.com/readthedocs/readthedocs.org/pull/9170>`__)
* `@stsewd <https://github.com/stsewd>`__: Proxito: serve static files from the same domain as the docs (`#9168 <https://github.com/readthedocs/readthedocs.org/pull/9168>`__)
* `@stsewd <https://github.com/stsewd>`__: User: delete organizations where the user is the last owner (`#9164 <https://github.com/readthedocs/readthedocs.org/pull/9164>`__)
* `@ericholscher <https://github.com/ericholscher>`__: Add a basic djstripe integration (`#9087 <https://github.com/readthedocs/readthedocs.org/pull/9087>`__)
* `@stsewd <https://github.com/stsewd>`__: Custom domains: don't allow adding a custom domain on subprojects (`#8953 <https://github.com/readthedocs/readthedocs.org/pull/8953>`__)

Version 8.0.1
-------------

:Date: May 09, 2022

* `@ericholscher <https://github.com/ericholscher>`__: Fix RTD branding in the code (`#9175 <https://github.com/readthedocs/readthedocs.org/pull/9175>`__)
* `@ericholscher <https://github.com/ericholscher>`__: Remove our old out-dated architecture diagram (`#9169 <https://github.com/readthedocs/readthedocs.org/pull/9169>`__)
* `@humitos <https://github.com/humitos>`__: Docs: mention `ubuntu-22.04` as a valid option (`#9166 <https://github.com/readthedocs/readthedocs.org/pull/9166>`__)
* `@ericholscher <https://github.com/ericholscher>`__: Initial test of adding plan to CDN (`#9163 <https://github.com/readthedocs/readthedocs.org/pull/9163>`__)
* `@ericholscher <https://github.com/ericholscher>`__: Fix links in docs from the build page refactor (`#9162 <https://github.com/readthedocs/readthedocs.org/pull/9162>`__)
* `@stsewd <https://github.com/stsewd>`__: Analytics: skip requests from bots on 404s (`#9161 <https://github.com/readthedocs/readthedocs.org/pull/9161>`__)
* `@ericholscher <https://github.com/ericholscher>`__: Note build.jobs required other keys (`#9160 <https://github.com/readthedocs/readthedocs.org/pull/9160>`__)
* `@ericholscher <https://github.com/ericholscher>`__: Add docs showing pip-tools usage on dependencies (`#9158 <https://github.com/readthedocs/readthedocs.org/pull/9158>`__)
* `@ericholscher <https://github.com/ericholscher>`__: Expierment with pip-tools for our docs.txt requirements (`#9124 <https://github.com/readthedocs/readthedocs.org/pull/9124>`__)
* `@ericholscher <https://github.com/ericholscher>`__: Add a basic djstripe integration (`#9087 <https://github.com/readthedocs/readthedocs.org/pull/9087>`__)

Version 8.0.0
-------------

Expand Down
2 changes: 1 addition & 1 deletion common
4 changes: 2 additions & 2 deletions dockerfiles/nginx/proxito.conf
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ server {
}

# Sendfile support to serve the actual files that Proxito has specified
location /proxito/ {
location ~* "^/(proxito|proxito-static)/(.+)" {
internal;
# Nginx will strip the `/proxito/` and pass just the `$storage/$type/$proj/$ver/$filename`
proxy_pass http://storage:9000/;
proxy_pass http://storage:9000/$2;

proxy_set_header Host storage:9000;
proxy_set_header X-Real-IP $remote_addr;
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@

master_doc = "index"
copyright = "2010, Read the Docs, Inc & contributors"
version = "8.0.0"
version = "8.0.2"
release = version
exclude_patterns = ["_build"]
default_role = "obj"
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 0 additions & 41 deletions docs/dev/architecture.rst

This file was deleted.

53 changes: 38 additions & 15 deletions docs/dev/contribute.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,41 @@
Contributing to Read the Docs
=============================

You are here to help on Read the Docs? Awesome, feel welcome and read the
following sections in order to know how to ask questions and how to work on something.
Are you here to help on Read the Docs? Awesome! |:heart:|

Read the Docs, and all of it's related projects, are all community maintained,
open-source projects. We hope you feel welcome as you begin contributing to any
of these projects. You'll find that development is primarily supported by our
core team members, who all work on Read the Docs full-time.

All members of our community are expected to follow our :doc:`/code-of-conduct`.
Please make sure you are welcoming and friendly in all of our spaces.

Get in touch
------------

If you have a question or comment, we generally suggest the following
communication channels:

- Ask usage questions ("How do I?") on `StackOverflow`_.
- Report bugs, suggest features or view the source code `on GitHub`_.
- Discuss topics on `Gitter`_.
- Report bugs, suggest features, or view the source code `on GitHub`_.
- Discuss development topics on `Gitter`_.

.. _StackOverFlow: https://stackoverflow.com/questions/tagged/read-the-docs
.. _on GitHub: https://github.com/readthedocs/readthedocs.org
.. _Gitter: https://gitter.im/readthedocs/community

Contributing
------------

There are plenty of places to contribute to Read the Docs, but if you are just
starting with contributions, we suggest focusing on the following areas:

.. contents::
:local:

Contributing to development
---------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to deep dive and help out with development on Read the Docs, then
first get the project installed locally according to the
Expand Down Expand Up @@ -50,19 +66,33 @@ When contributing code, then please follow the standard Contribution Guidelines


Contributing to documentation
-----------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Documentation for Read the Docs itself is hosted by Read the Docs at https://docs.readthedocs.io (likely the website you are currently reading).

There are guidelines around writing and formatting documentation for the project.
For full details, including how to build it, see :doc:`/docs`.

Contributing to translations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We use Transifex to manage localization for all of our projects that we support
localization on. If you are interested in contributing, we suggest joining a
team on one of `our projects on Transifex`_. From there, you can suggest
translations, and can even be added as a reviewer, so you can correct and
approve suggestions.

If you don't see your language in our list of approved languages for any of our
projects, feel free to suggest the language on Transifex to start the process.

.. _our projects on Transifex: https://www.transifex.com/projects/p/readthedocs/

Triaging tickets
----------------

Here is a brief explanation on how we triage incoming tickets to get a better
sense of what needs to be done on what end.
Core team uses the following guidelines for issue triage on all of our projects.
These guidelines describe the issue lifecycle, and what is required at each step
of this lifecycle.

.. note:: You will need Triage permission on the project in order to do this.
You can ask one of the members of the :doc:`team` to give you access.
Expand Down Expand Up @@ -223,10 +253,3 @@ Here is a list of links for contributors that look for work:
<https://github.com/readthedocs/readthedocs.org/issues?q=is:open+is:issue+label:"Needed:+design+decision">`_:
Project leaders must take actions on these tickets. Otherwise no other
contributor can go forward on them.

Helping on translations
-----------------------

If you wish to contribute translations, please do so on `Transifex`_.

.. _Transifex: https://www.transifex.com/projects/p/readthedocs/
Loading

0 comments on commit 4babe55

Please sign in to comment.