-
Notifications
You must be signed in to change notification settings - Fork 0
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
Better section naming and organization #8
Conversation
… see in this doc, and to make it not pretend to tell you about awscli in the heading since the actual text barely mentions awscli. Remove a useless link to the overview on the first page.
docs/source/rclone_instead.rst
Outdated
Awscli/Rclone Submission (experimental) | ||
======================================= | ||
=================================== | ||
Using rclone instead (experimental) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider dropping this section from the documentation entirely for the time being. I don't believe we're looking to utilize rclone in this fashion for SMaHT (via a publicly available bucket), though I know we're looking at the possibility of integrating the tool at some point.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that's fine with me. This section is available in the CGAP documentation. Maybe I can rearrange the CGAP documentation in this same way and just leave it there. Did it make more sense in that context, or ought it be removed there as well? For tentative removals, I just rename files to whatever.DISABLED and I can do that rather than deletion if you're uncertain as to whether we'd want to later add it back in one or the other context).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It made sense in the context of CGAP, so I think rearranging there is a good idea. Disabling for this repo is best for now to prevent possible miscommunication with SMaHT folks until we have settled the issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great. That's what I'll do then.
rclone
support not be the first thing that you see in this doc, since non-experimental stuff needs to be first.rclone
section not pretend to tell you aboutawscli
in the heading, since the actual text barely mentionsawscli
.rclone
to make the motivational part clearer.NOTE TO REVIEWERS:
You can preview this by downloading the repo and doing
That will build an html set in
docs/html/
(which I've made invisible due to .gitignore) and will open a browser to view it.