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

Add content only found in classic PDF guides #13

Open
aputtu opened this issue Jul 2, 2024 · 3 comments
Open

Add content only found in classic PDF guides #13

aputtu opened this issue Jul 2, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@aputtu
Copy link
Contributor

aputtu commented Jul 2, 2024

On erda.ku.dk we have the main ERDA User Guide and various intro guides.

We need to make sure we get all content moved over to Sphinx documentation, so that it can become searchable.
We accept including the classic PDF guides as static content, so we can go live before completing the tasks.
However, this ticket is created to make sure we actually get to a point where the need for them is gone.

@aputtu aputtu added the documentation Improvements or additions to documentation label Jul 2, 2024
@aputtu
Copy link
Contributor Author

aputtu commented Jul 23, 2024

toc-old-doc_2024-07-23.txt
In attached txt I've added an overview of the guides, including a breakdown of the major User Guide + one FAQ item that has been added very recently.
(Basically, this is what needs to be included. I'll our Sphinx now, see what has not been ported, and add missing sections as subtask.)

@aputtu
Copy link
Contributor Author

aputtu commented Jul 23, 2024

Initial breakdown of what we still are missing.
Under "How to Access UCPH ERDA"

  • Files (@SebastianPrehn)
  • File Sharing and Data Exchange
  • Settings + Setup
    Under "Advanced Data Access"
  • WebDAVS
  • SFTP
  • FTPS
  • WebDAVS/SFTP/FTPS Access to Share Links
  • Automatic Backup to ERDA
  • Schedule Tasks
  • Data Import/Export

Also main sections:

  • Courses and External Collaboration
  • Support, Questions and Comments

FAQ item:

  • Can I use SSH to log in or use rsync to synchronize data with ERDA

@SebastianPrehn
Copy link
Contributor

SebastianPrehn commented Aug 14, 2024

WebDAVS and SFTP should be concluded with https://migrid-user-docs.readthedocs.io/en/latest/sections/erda/networkdrive/index.html

It would potentially be an idea to add Share Links sections to each of those, or a third page in that selection describing it, as well as as a page for FTPS.

Potentially https://migrid-user-docs.readthedocs.io/en/latest/sections/erda/files/index.html is a good start or the task "File Sharing and Data Exchange"

SebastianPrehn added a commit that referenced this issue Aug 21, 2024
Add FTPS section in accordance with #13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants