revamp getting started

Sage-Bionetworks · Dec 22, 2023 · c45c629 · c45c629
1 parent 0bd4793
commit c45c629
Show file tree

Hide file tree

Showing 31 changed files with 516 additions and 109 deletions.
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/docs/assets/under_construction.png b/docs/assets/under_construction.png
diff --git a/docs/explanations/domain_models_of_synapse.md b/docs/explanations/domain_models_of_synapse.md
@@ -0,0 +1,20 @@
+# Domain Model of Synapse
+Here you'll find more information about how all of the models/concepts of Synapse
+work together and what their purpose is.
+
+## Projects
+Projects in Synapse are “containers” that group relevant content and people together. All data must be uploaded into a project. Projects can be private so only you can see the contents, they can be shared with your collaborators, or they can be made public so anyone on the web can view your research.
+
+Projects help you to:
+
+* **Organize your work**: With Synapse, you can organize the parts in your workflow (data, code, etc) into a hierarchy like a file system. With the tabs across the top of each project, you can easily navigate to your wikis, files and folders, SQL-based tables, and even conduct conversations using discussion forums.
+
+* **Store data, code, and results**: You can upload your data, code, and results to Synapse, or store a reference to their location in your local computer system or on the web. Everything can be stored as files hosted by Synapse, in your own external cloud storage, or using Docker containers.
+
+* **Control data access or release it publicly**: You have complete control over how users and groups can interact with your work. Work privately, openly, or somewhere in between.
+
+* **Link and share content with others**: Just as you can control the access to your work, projects can serve as a platform for linking and sharing your work with others.
+
+* **Custom, searchable annotations**: Assign any key/value pair you want. Those values become searchable and available to those granted access.
+
+* **Attach figures and documents**: Upload documents and images via the website or programmatically.
diff --git a/docs/explanations/home.md b/docs/explanations/home.md
@@ -0,0 +1,4 @@
+# Further Reading
+Welcome!
+
+This is where you'll find information that gives you a deeper understanding of best practices and advanced use cases for interacting with Synapse.
diff --git a/docs/guides/home.md b/docs/guides/home.md
@@ -0,0 +1,5 @@
+# How-To Guides
+Welcome!
+
+In this module you'll find extensive examples of all the things you can do with the
+Synapse Python/Command line client.
diff --git a/docs/index.md b/docs/index.md
@@ -12,4 +12,18 @@ The `synapseclient` package lets you communicate with the cloud-hosted Synapse s
 
 Installing this package will install `synapseclient`, `synapseutils` and the command line client. `synapseutils` contains beta features and the behavior of these features are subject to change.
 
-If you're just getting started with Synapse, have a look at the Getting Started guides for [Synapse](https://help.synapse.org/docs/Getting-Started.2055471150.html).
+## What’s on this docs site for you?
+* [Installation](./tutorials/installation.md), [Authentication](./tutorials/authentication.md), and [Configuration](./tutorials/configuration.md) of the `synapseclient`
+* [Tutorials](./tutorials/home.md) to get you and your team sharing, organizing, and discussing your scientific research
+* [How-To Guides](./guides/home.md) showcasing the full power and functionality available to you
+* [API Reference](./reference/client.md) of the programatic interfaces
+* [Further Reading](./explanations/home.md) to gain a deeper understanding of best practices and advanced use cases
+* Our [release notes](./news.md)
+
+## Additional Background
+
+* Read [about Synapse](https://help.synapse.org/docs/About-Synapse.2058846607.html)—how it got started and how it fits into the bigger data-sharing picture
+* Gain a better understanding of [Sage Bionetworks](https://help.synapse.org/docs/About-Synapse.2058846607.html#AboutSynapse-WhomanagesSynapse?) (that’s us—the nonprofit organization that created Synapse) and our other platforms that coincide with Synapse (such as portals)
+* Learn about [Synapse governance](https://help.synapse.org/docs/Synapse-Governance.2004255211.html) and how it protects data privacy
+* Look up an unfamiliar term or acronym in our [glossary](https://help.synapse.org/docs/Glossary.2667938103.html)
+* See our [help section](https://help.synapse.org/docs/Help.2650865669.html) for further assistance via the FAQ page, discussion forum, or contact information to get in touch