Move wipe button to version detail page #3417
Conversation
|
Looks good. |
|
Feel like this will be confusing for existing users, we should update the docs too, if we haven't @humitos want to include a guide on this? http://docs.readthedocs.io/en/latest/guides/index.html |
|
Also http://docs.readthedocs.io/en/latest/faq.html#deleting-a-stale-or-broken-build-environment needs to get updated |
| {{ form.as_p }} | ||
| <p> | ||
| <input style="display: inline;" type="submit" value="Save"> | ||
| or |
There was a problem hiding this comment.
Save and or should be translated too
|
@ericholscher FAQ updated and guide created. Take a look at it and let me know. Feel free to fix any English mistake you find in these files or comment on them if it works best for you. |
Instead of being a button under detail page, it follows the same idea of deleting a project: a link next to the Save button.
humitos
force-pushed
the
humitos/wipe/move-button
branch
from
f59f205
to
8d447ec
Compare
docs/faq.rst
Outdated
| @@ -109,7 +109,7 @@ following settings:: | |||
| Deleting a stale or broken build environment | |||
| -------------------------------------------- | |||
|
|
|||
| If you're having trouble getting your version to build, try wiping out the existing build/environment files. On your version list page ``/projects/[project]/versions`` there is a "Wipe" button that will remove all of the files associated with your documentation build, but not the documentation itself. | |||
| If you're having trouble getting your version to build, try wiping out the existing build/environment files. On each version detail page ``/projects/[project]/version/[slug]`` there is a "wipe" link at the bottom of the page (next to the "Save" button) that will remove all of the files associated with your documentation build, but not the documentation itself. | |||
There was a problem hiding this comment.
I'd just delete this and point it at the guide? Probably a useful thing to do with other FAQ's that we should write a guide about.
There was a problem hiding this comment.
I like the idea. Besides, there is no need to matain in two places the same instructions.
What are you thinking? Something just like
See: :doc:`guides/wipe-environment`
or something more elaborated?
docs/guides/wipe-environment.rst
Outdated
| environment where the documentation is created is stale or | ||
| broken. This could happen for a couple of different reasons like `pip` | ||
| not upgrading a package properly or a corrupted cached Python package, | ||
| for example. |
docs/guides/wipe-environment.rst
Outdated
| for example. | ||
|
|
||
| In any of these cases (and many others), the solution could be just | ||
| wiping out the existing build/environment files and allow Read the |
There was a problem hiding this comment.
build/environment is weird. I'd just choose one and stick with it, perhaps build environment
docs/guides/wipe-environment.rst
Outdated
|
|
||
| By wiping the documentation build/environment, all the files | ||
| associated with it will be removed but not the documentation | ||
| itself. |
There was a problem hiding this comment.
This is confusing. Perhaps:
By wiping the documentation build environment, all the rst, md, & code files
associated with it will be removed but not the HTML/PDF itself.
Or something. We should be really explicit with what is happening.
There was a problem hiding this comment.
I tried to make it more explicit regarding the type of files that are going to be deleted and also add a mention like "your documentation will still online" to make it clear that wiping an build environment won't destroy your docs.
No description provided.