Merge pull request #40 from FirelyTeam/FAQs

Added FAQs, overview page, npm adjustment

FAQs.rst

@@ -0,0 +1,48 @@
+.. _FAQs:
+
+Frequently Asked Questions
+==========================
+
+Is it possible to delete or rename a package?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+It is not possible to delete or rename a package once it is created. You can only “unlist”  a package, this will make the package only visible to the creators of the package. 
+Once a package is created the FHIR community should be able to depend on the continued existence of that package. Renaming or deleting would make that impossible. 
+
+Can I customize the way resources are shown in Simplifier?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This is possible by using `Metadata Expressions <./getting_started/simplifierResources.html#metadata-expressions>`_. Note that in order to use Metadata Expressions, you need at least a `Professional plan <https://simplifier.net/pricing>`_.
+
+Can I sync from Simplifier back to GitHub using Simplifier GitHub Sync?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+It is only possible to sync from GitHub to Simplifier and not the other way round. A workaround would be to sync your Simplifier work with your local folder using Forge or Firely Terminal and then commit that to Github. 
+For more information, have a look at our `GitHub Sync documentation <./data_governance_and_quality_control/simplifierGithub.html>`_.
+
+Does Simplifier support Custom Resources?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+It is possible to upload custom resources to Simplifier, but in general the use of Custom Resources in Simplifier is not recommended, as you may experience issues when validating or rendering resources. 
+It is also not possible to upload examples of custom resources.
+
+What file formats can you upload to Simplifier?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can upload .txt, .json, .xml, .yaml, .md, and image files to Simplifier.
+
+Can I transfer projects to a different team?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This is possible, please have a look at `our Team Management documentation </data_governance_and_quality_control/simplifierGithub.html>`_.
+
+How do I update package release notes after releasing a new package?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can add release notes when you create a new version of your existing package:
+
+.. image:: ./images/PackageNewVersion.png
+
+In the following screen, you can add release notes to this package, as well as the version number and details on the author:
+
+.. image:: ./images/PackageReleaseNotes.png

features/api.rst

@@ -116,7 +116,7 @@ Besides the regular package endpoint, there is also a more limited NPM compatibl
 
 ::
   
-  https://packages.simplifier.net/<name>/-/<package-name>-<package-version>.tgz
+  https://packages.simplifier.net/<package-name>/-/<package-name>-<package-version>.tgz
 
 
 The above example, then becomes:

getting_started/getting_started.rst

@@ -3,13 +3,12 @@
 Starting with Simplifier
 ========================
 
-Here you will find some stepping stones in getting familiar with Simplifier. If you would like to learn more you can also take a look at our `training courses at firely <https://fire.ly/training/hl7-fhir-overview-course/#upcoming-cources>`_.
+Here you will find some stepping stones in getting familiar with Simplifier.
 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 
-   simplifierIntro
    simplifierPersonalContent
    simplifierProjects
    simplifierResources

index.rst

@@ -28,11 +28,13 @@ In addition to the release notes on `the Release notes page <https://docs.fire.l
   :maxdepth: 1
   :caption: Simplifier.net Docs:
 
+  Simplifier Overview <simplifierIntro>
   Starting with Simplifier <getting_started/getting_started>
   Team and Organization management <administration/administration>
   Data Governance and Quality Control <data_governance_and_quality_control/data_governance_and_quality_control>
   Implementation Guide <implementation_guide/implementation_guide>
   Additional features and playgrounds<features/features>
   Release notes <simplifierReleaseNotes>
+  FAQs <FAQs>
   Contact <simplifierContact>  
   Accessibility <accessibility>

getting_started/simplifierIntro.rst → simplifierIntro.rst

@@ -1,7 +1,7 @@
-Introduction to Simplifier.net
-==============================
+Overview of Simplifier.net
+==========================
 
-.. image:: ../images/Illustrations_Firely-03.png
+.. image:: ./images/Illustrations_Firely-03.png
   :align: right
   :width: 250px
   :alt: Collaborating on a FHIR project
@@ -18,7 +18,7 @@ Simplifier is the backbone for the FHIR registry. The `FHIR registry <https://re
 
 Below you can download a quick guide to the FHIR registry, which was made for the HL7 Working Group Meeting in New Orleans (Jan, 2018).
 
-:download:`Quick guide to the FHIR registry (pdf) <../QuickGuideFHIRregistry.pdf>`
+:download:`Quick guide to the FHIR registry (pdf) <./QuickGuideFHIRregistry.pdf>`
 
 Simplifier accounts
 -------------------
@@ -38,3 +38,27 @@ Simplifier content
 ------------------
 
 Simplifier is specially created for Data Modelers, Developers and Clinical Informatics Specialists. The available FHIR content is organized at four levels: Users, Resources, Projects and Organizations. You can import your FHIR resources and make use of the seamless integration between Forge and Simplifier.  
+
+Learning more
+-------------
+
+Firely offers trainings if you would like to get more familiar with `Simplifier <https://fire.ly/training/simplifier-suite-workshop/>`_ and/or `Data Modeling <https://fire.ly/training/hl7-fhir-profiling-course/>`_.
+You can pick a timeslot that fits your schedule, and these trainings can be tailored to the needs of you and your team. In addition to the Simplifier and Modeling trainings there is also a wide range of `other courses <https://fire.ly/training/>`_ available to get acquainted or more experienced with FHIR and the FHIR tooling provided by Firely. 
+Additional information, such as eBooks and Case Studies, can be found on `Firely's resource page <https://fire.ly/resources/>`_. Also, don't forget to take a look at our interesting `blogposts <https://fire.ly/blog/>`_.
+
+.. image:: ./images/Illustrations_Firely-01.png
+  :align: right
+  :width: 250px
+  :alt: Working with Simplifier
+
+
+Quick Navigation
+----------------
+
+- `I want to create a project in Simplifier <./getting_started/simplifierProjects.html>`_
+- `I want to create a package using Simplifier <./data_governance_and_quality_control/simplifierPackages.html>`_
+- `I want to use Simplifier in combination with Github <./data_governance_and_quality_control/simplifierGithub.html>`_
+- `I want to load my Simplifier resources in Firely Server <./features/simplifierFirely-server.html>`_
+- `I want to query FHIR resources <./features/simplifierFQL.html>`_
+- `I want to create an implementation guide for my project <./implementation_guide/implementation_guide.html>`_
+