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

Move wipe button to version detail page #3417

Merged
merged 7 commits into from Dec 21, 2017
Merged

Conversation

@humitos
Copy link
Member

@humitos humitos commented Dec 18, 2017

No description provided.

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Dec 18, 2017

Looks good.

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Dec 18, 2017

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

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Dec 18, 2017

Copy link
Member

@ericholscher ericholscher left a comment

Requesting above ^^

{{ form.as_p }}
<p>
<input style="display: inline;" type="submit" value="Save">
or
Copy link
Member

@stsewd stsewd Dec 19, 2017

Save and or should be translated too

Copy link
Member Author

@humitos humitos Dec 20, 2017

Done, thanks!

Copy link
Contributor

@agjohnson agjohnson left a comment

Seconding localization of the form and notes on updating our docs. I believe we are specifically referencing the wipe button being on the version list page in our docs.

@humitos
Copy link
Member Author

@humitos humitos commented Dec 20, 2017

@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.

humitos added 5 commits Dec 20, 2017
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 humitos force-pushed the humitos/wipe/move-button branch from f59f205 to 8d447ec Dec 20, 2017
Copy link
Member

@ericholscher ericholscher left a comment

Love this! Just a few nitpicks.

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.
Copy link
Member

@ericholscher ericholscher Dec 20, 2017

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.

Copy link
Member Author

@humitos humitos Dec 21, 2017

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?

Copy link
Member

@ericholscher ericholscher Dec 21, 2017

wfm

Copy link
Member Author

@humitos humitos Dec 21, 2017

Done.

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.
Copy link
Member

@ericholscher ericholscher Dec 20, 2017

, for example not needed

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
Copy link
Member

@ericholscher ericholscher Dec 20, 2017

build/environment is weird. I'd just choose one and stick with it, perhaps build environment


By wiping the documentation build/environment, all the files
associated with it will be removed but not the documentation
itself.
Copy link
Member

@ericholscher ericholscher Dec 20, 2017

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.

Copy link
Member Author

@humitos humitos Dec 21, 2017

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.

@ericholscher ericholscher merged commit 4a835b4 into master Dec 21, 2017
1 check passed
@stsewd stsewd deleted the humitos/wipe/move-button branch Aug 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants