Skip to content

Commit

Permalink
Update simplifierGitHub.rst and index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
ArdonToonstra committed Jul 22, 2016
1 parent 5d86ed6 commit d04a987
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs_simplifier/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Contents:
simplifierBrowse
simplifierResources
simplifierPersonalContent
simplifierGithub
simplifierGitHub
simplifierConnectors
simplifierWriteConnector
simplifierIGeditor
Expand Down
23 changes: 16 additions & 7 deletions docs_simplifier/simplifierGithub.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Github integration
GitHub integration
==================
The Github integration enables you to link Simplier projects to Github repositories. When linking the project with the repository, the
resources from the repository are fetched and added to your Simplifier project.
Expand All @@ -7,16 +7,25 @@ This page will elaborate further on how to perform the linking.
GitHub Linking
--------------

In order to link your Simplifier project to one repository from your Github account ....
You can link a repository in Github to your Simplifier project by
going to your project and selecting the "Link to Github Repository" under the Options menu.
You will be redirected to the GitHub login or, when you are already logged in in GitHub, straight
to the page where you will be asked to authorize that Simplifier can access your repository.

When that succeeds, you will be directed back to Simplifier, where Simplifier will ask you
which repository you want to link and which branch within that repository.

Settings
--------
When connecting a GitHub repository you will be asked to choose a strategy on how
to deal with resources that fail to import (most likely because they are not valid FHIR resources)
and whether to remove resources from your project when they are removed from your repository.

Data Import Fail Strategy
Deletion Strategy

Fetch Updates
-------------
After the linking is performed, any updates on your resources in the Github repository will be sent automatically to Simplifier. Based on the linking settings, resources from your Simplifier project will be updates/deleted/added with the new information from Github.
After the linking is performed, any updates on your resources in the Github repository will
be sent automatically to Simplifier. Based on the the linking settings, resources
from your Simplifier project will be updates/deleted/added from Github.


Github Organizations
-------------------

0 comments on commit d04a987

Please sign in to comment.