Skip to content

Commit 1d846c7

Browse files
committed
Remove api v3
1 parent 5ba4038 commit 1d846c7

File tree

1 file changed

+40
-53
lines changed

1 file changed

+40
-53
lines changed

docs/gsoc.rst

+40-53
Original file line numberDiff line numberDiff line change
@@ -64,50 +64,6 @@ We will consider the priority on our roadmap as a factor,
6464
along with the skill of the student,
6565
in our selection process.
6666

67-
API V3
68-
~~~~~~
69-
70-
We currently have a "v2" API that isn't well documented and doesn't allow users to write to it.
71-
We want to continue using Django REST Framework for this,
72-
but rethink how we're presenting our information to our users.
73-
74-
Currently we're showing everything as simple "models",
75-
and we want to start exposing "methods" on our data,
76-
similar to GitHub.
77-
78-
This is a large project and should only be done by someone who has done some basic API design previously.
79-
80-
Improve Translation Workflow
81-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
82-
83-
Currently we have our documentation & website translated on Transifex,
84-
but we don't have a management process for it.
85-
This means that translations will often sit for months before making it back into the site and being available to users.
86-
87-
This project would include putting together a workflow for translations:
88-
89-
* Communicate with existing translators and see what needs they have
90-
* Help formalize the process that we have around Transifex to make it easier to contribute to
91-
* Improve our tooling so that integrating new translations is easier
92-
93-
Support for additional build steps for linting & testing
94-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95-
96-
Currently we only build documentation on Read the Docs,
97-
but we'd also like to add additional build steps that lets users perform more actions.
98-
This would likely take the form of wrapping some of the existing `Sphinx builders <http://www.sphinx-doc.org/en/stable/builders.html>`_,
99-
and giving folks a nice way to use them inside Read the Docs.
100-
101-
It would be great to have wrappers for the following as a start:
102-
103-
* Link Check (http://www.sphinx-doc.org/en/stable/builders.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder)
104-
* Spell Check (https://pypi.python.org/pypi/sphinxcontrib-spelling/)
105-
* Doctest (http://www.sphinx-doc.org/en/stable/ext/doctest.html#module-sphinx.ext.doctest)
106-
* Coverage (http://www.sphinx-doc.org/en/stable/ext/coverage.html#module-sphinx.ext.coverage)
107-
108-
The goal would also be to make it quite easy for users to contribute third party build steps for Read the Docs,
109-
so that other useful parts of the Sphinx ecosystem could be tightly integrated with Read the Docs.
110-
11167
Collections of Projects
11268
~~~~~~~~~~~~~~~~~~~~~~~
11369

@@ -124,6 +80,19 @@ we would allow them to do a few sets of actions on them:
12480

12581
There is likely other ideas that could be done with `Collections` over time.
12682

83+
Autobuild docs for Pull Requests
84+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
85+
86+
It would be great to automatically build docs for Pull Requests in GitHub repos that our users have.
87+
Currently we don't support this,
88+
and it's one of our most requested features.
89+
90+
This would include:
91+
92+
* Modeling Pull Requests as a type of version alongside Tags and Branches
93+
* Modifying how we upload HTML docs to store them in a place like S3 for long term storage
94+
* Build integration with GitHub to send the status notifications when a PR is building and complete
95+
12796
Integrated Redirects
12897
~~~~~~~~~~~~~~~~~~~~
12998

@@ -140,18 +109,36 @@ We should rebuild how we handle redirects across a number of cases:
140109

141110
There will also be a good number of things that spawn from this, including version aliases and other related concepts, if this task doesn't take the whole summer.
142111

143-
Autobuild docs for Pull Requests
144-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112+
Improve Translation Workflow
113+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145114

146-
It would be great to automatically build docs for Pull Requests in GitHub repos that our users have.
147-
Currently we don't support this,
148-
and it's one of our most requested features.
115+
Currently we have our documentation & website translated on Transifex,
116+
but we don't have a management process for it.
117+
This means that translations will often sit for months before making it back into the site and being available to users.
149118

150-
This would include:
119+
This project would include putting together a workflow for translations:
151120

152-
* Modeling Pull Requests as a type of version alongside Tags and Branches
153-
* Modifying how we upload HTML docs to store them in a place like S3 for long term storage
154-
* Build integration with GitHub to send the status notifications when a PR is building and complete
121+
* Communicate with existing translators and see what needs they have
122+
* Help formalize the process that we have around Transifex to make it easier to contribute to
123+
* Improve our tooling so that integrating new translations is easier
124+
125+
Support for additional build steps for linting and testing
126+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127+
128+
Currently we only build documentation on Read the Docs,
129+
but we'd also like to add additional build steps that lets users perform more actions.
130+
This would likely take the form of wrapping some of the existing `Sphinx builders <http://www.sphinx-doc.org/en/stable/builders.html>`_,
131+
and giving folks a nice way to use them inside Read the Docs.
132+
133+
It would be great to have wrappers for the following as a start:
134+
135+
* Link Check (http://www.sphinx-doc.org/en/stable/builders.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder)
136+
* Spell Check (https://pypi.python.org/pypi/sphinxcontrib-spelling/)
137+
* Doctest (http://www.sphinx-doc.org/en/stable/ext/doctest.html#module-sphinx.ext.doctest)
138+
* Coverage (http://www.sphinx-doc.org/en/stable/ext/coverage.html#module-sphinx.ext.coverage)
139+
140+
The goal would also be to make it quite easy for users to contribute third party build steps for Read the Docs,
141+
so that other useful parts of the Sphinx ecosystem could be tightly integrated with Read the Docs.
155142

156143
More info here:
157144

0 commit comments

Comments
 (0)