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

[MNT]: Update install and usage docs #31

Merged
merged 31 commits into from
Jun 14, 2019
Merged

Conversation

asreimer
Copy link
Contributor

@asreimer asreimer commented Jun 8, 2019

This PR is for updating the usage documentation following the changes implemented in #27 and to update the installation docs for installation of resen on Windows systems.

You can view this version of the readthedocs here: https://resen.readthedocs.io/en/mnt_update_windows_docs/

PR #27 needs to be merged before this.

@asreimer asreimer added the Maintenance Cleanup and housekeeping. label Jun 8, 2019
@ljlamarche
Copy link
Contributor

Looks good! Couple things:

  1. Missing screen shots for Windows Installation. @asreimer , did you say you had these already, or do we need to create them still? We can use @astib windows laptop if necessary.
  2. The windows installation instructions are now very thorough. Should I put together a similar description for installation on Mac? I used Docker Desktop though, and I believe that was fairly straight forward.
  3. It might be a good idea to link the "Installation" and the "Installing on Windows" pages. "Installing on Windows" could be a sub-page to a general Installation page, or we could just link it to the "Windows" section in the Docker installation instructions section. It looks like most of the trickiness is in installing Docker.

@asreimer
Copy link
Contributor Author

I have screenshots and such. This isn't done yet.

@asreimer
Copy link
Contributor Author

Ok, I think this is finally done from the windows perspective. Let's keep this open and update the docs after we have finished changing the resen command line interface (solidify the create_bucket workflow, etc).

@asreimer asreimer mentioned this pull request Jun 14, 2019
@pmreyes2
Copy link
Contributor

The usage documentation has been updated according to the latest resen command line interface changes.

@ljlamarche
Copy link
Contributor

Looks good to me. Did we intentionally reduce the TOC levels so there's no longer a sidebar to navigate between pages, or is that a remnant (or a weird version of read the docs I'm looking at)?

@asreimer
Copy link
Contributor Author

@pmreyes2 didn't touch the index files, but somehow the TOC changed...

Weird. Need to look at this.

@asreimer
Copy link
Contributor Author

Docs are building fine now and done.

@asreimer asreimer merged commit fe131d6 into develop Jun 14, 2019
@asreimer asreimer deleted the mnt_update_windows_docs branch June 14, 2019 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Cleanup and housekeeping.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants