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

This is a test #3

Open
wants to merge 69 commits into
base: documentation-scott
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
8a66fc6
Merge pull request #1 from scottvieira/documentation-scott
scottvieira Sep 2, 2016
f37c207
Merge pull request #2 from scottvieira/documentation-scott
scottvieira Sep 15, 2016
4ad5c9e
Merge remote-tracking branch 'refs/remotes/origin/documentation-scott…
Oct 5, 2016
4e0483b
Create for testing
xsong9 Oct 6, 2016
25c8b4a
test1 release2
Oct 6, 2016
7509053
Merge pull request #5 from scottvieira/test1
scottvieira Oct 6, 2016
ec9ad5e
test2 edit release
Oct 6, 2016
724e55f
Merge remote-tracking branch 'refs/remotes/origin/master' into docume…
Oct 6, 2016
989e042
test2 release edit 2
Oct 6, 2016
c091546
Merge pull request #6 from scottvieira/test2
scottvieira Oct 6, 2016
4b27aaf
Update README.md
scottvieira Oct 6, 2016
383e4c4
Update README.md
scottvieira Oct 6, 2016
7252e22
Merge pull request #4 from scottvieira/documentation-yan
xsong9 Oct 10, 2016
4b48a12
Merge remote-tracking branch 'refs/remotes/origin/master' into docume…
Oct 21, 2016
565faa2
added emoticons
Oct 21, 2016
3c51603
attempting to remove emoticons
Oct 21, 2016
b6b1a67
added helloworld to test1 branch
Oct 21, 2016
541e54f
removed helloworld
Oct 21, 2016
de2ce8d
update organization's images
Nov 14, 2016
f6df928
image notes in docstyleguide
Nov 14, 2016
d89135a
delete images
Nov 14, 2016
a96a2ec
cleanup
Nov 15, 2016
59210cf
image add
Nov 15, 2016
d3f3dbe
cleanup
Nov 15, 2016
613f224
test1
Nov 15, 2016
600a0b3
test1 removed
Nov 15, 2016
d3e45d4
test2
Nov 15, 2016
557f6b6
update org images
Nov 15, 2016
a562706
update image guidelines
Nov 15, 2016
55b1aea
add file import
xsong9 Nov 21, 2016
8d97033
add resources images
xsong9 Nov 21, 2016
ad1f057
added images for resources module
xsong9 Nov 21, 2016
27296bb
Merge pull request #1 from Coral-erm/YanResources
scottvieira Nov 21, 2016
24ac864
add management
scottvieira Nov 22, 2016
575d2cf
changes org examples to plural
Nov 22, 2016
d90a8e0
made changes to org examples
Nov 22, 2016
ec94096
Merge remote-tracking branch 'refs/remotes/origin/master' into docume…
Nov 22, 2016
867c73b
add new organizations images
Nov 22, 2016
17930fc
made edits to text and inserted images
Nov 22, 2016
e9d90f5
create general img subdir and uploaded icon images
Nov 22, 2016
6b1dab4
make edits to text and inserted images
Nov 22, 2016
15e8af9
edited view icon img
Nov 22, 2016
c57fdd1
addscreenshots for management module
Nov 22, 2016
c2bb0a1
inserted icons
Nov 22, 2016
0026e6c
inserted icons
Nov 22, 2016
3312261
Merge pull request #2 from Coral-erm/documentation-louisa
scottvieira Nov 23, 2016
18e438a
migrate management text & insert images
scottvieira Nov 23, 2016
59977d7
management update
scottvieira Nov 23, 2016
19766b1
Merge remote-tracking branch 'refs/remotes/origin/master' into docume…
Nov 30, 2016
3f6480b
minor edits to text
Nov 30, 2016
94ef6aa
replace editdocumentrecord image
Nov 30, 2016
9f22cb9
made minor edits to text
Nov 30, 2016
2ee2183
test100
Dec 1, 2016
67cd496
test1000
Dec 1, 2016
467bd85
btest1 testedit
Dec 8, 2016
66b395d
btest6
Dec 8, 2016
be75991
Merge pull request #12 from scottvieira/btest6
scottvieira Dec 8, 2016
12b6d3d
Update import.md
scottvieira Dec 14, 2016
b12c71a
Update import.md
scottvieira Dec 14, 2016
c60581f
content edits to licensing doc up to display notes section
Jan 19, 2017
575c4c5
update licensing admin info and added new images
Jan 19, 2017
973cc6e
formatting edits, added screenshots, and further content edits throug…
Jan 19, 2017
53e8d5c
added more screenshots for licensing documentation
Jan 19, 2017
4968568
Merge remote-tracking branch 'refs/remotes/scottvieira/master' into d…
Jan 31, 2017
3fec4c4
more edits to licensing and additional licensing screenshots
Jan 31, 2017
1cecc88
Merge pull request #18 from Coral-erm/documentation-louisa
Jan 31, 2017
14288cd
added gitignore file
Jan 31, 2017
28b82b0
Add files via upload
Jan 31, 2017
bd97062
Merge pull request #21 from Coral-erm/documentation-louisa
Jan 31, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#
#gitignore
#

# exclude build directory
build/
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# Documentation
CORAL Documentation Project

***Beta*** CORAL Documentation Project
Binary file modified build/doctrees/authentication.doctree
Binary file not shown.
Binary file modified build/doctrees/basics.doctree
Binary file not shown.
Binary file modified build/doctrees/codingguidelines.doctree
Binary file not shown.
Binary file modified build/doctrees/docstyleguide.doctree
Binary file not shown.
Binary file modified build/doctrees/environment.pickle
Binary file not shown.
Binary file modified build/doctrees/faq.doctree
Binary file not shown.
Binary file modified build/doctrees/glossary.doctree
Binary file not shown.
Binary file modified build/doctrees/gokb.doctree
Binary file not shown.
Binary file modified build/doctrees/import.doctree
Binary file not shown.
Binary file modified build/doctrees/index.doctree
Binary file not shown.
Binary file modified build/doctrees/licensing.doctree
Binary file not shown.
Binary file removed build/doctrees/licensing2.doctree
Binary file not shown.
Binary file added build/doctrees/management.doctree
Binary file not shown.
Binary file modified build/doctrees/merge.doctree
Binary file not shown.
Binary file modified build/doctrees/organizations.doctree
Binary file not shown.
Binary file removed build/doctrees/organizations2.doctree
Binary file not shown.
Binary file modified build/doctrees/overview.doctree
Binary file not shown.
Binary file modified build/doctrees/release.doctree
Binary file not shown.
Binary file modified build/doctrees/resources.doctree
Binary file not shown.
Binary file removed build/doctrees/styleguide.doctree
Binary file not shown.
Binary file modified build/doctrees/sushi.doctree
Binary file not shown.
Binary file modified build/doctrees/technical.doctree
Binary file not shown.
Binary file modified build/doctrees/terms.doctree
Binary file not shown.
Binary file modified build/doctrees/translation.doctree
Binary file not shown.
Binary file modified build/doctrees/usagestats.doctree
Binary file not shown.
Binary file modified build/doctrees/website.doctree
Binary file not shown.
Binary file added build/html/_images/editicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified build/html/_images/image_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified build/html/_images/image_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified build/html/_images/image_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified build/html/_images/image_11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed build/html/_images/image_2.png
Binary file not shown.
Binary file removed build/html/_images/image_3.png
Binary file not shown.
Binary file removed build/html/_images/image_4.png
Binary file not shown.
Binary file removed build/html/_images/image_5.png
Binary file not shown.
Binary file removed build/html/_images/image_6.png
Binary file not shown.
Binary file added build/html/_images/managementAddOptionalNote.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/managementHomePage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/managementNewDocument.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/organizationsAccountView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/organizationsAddNewUser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/organizationsAliasesView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/organizationsContactView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/organizationsHomePage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/organizationsIssuesView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/organizationsLicensesView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/organizationsRecordView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/resourcesAccess.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/resourcesAcquistion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/html/_images/resourcesAddNewNote.png
Binary file added build/html/_images/resourcesAddNewResource.png
Binary file added build/html/_images/resourcesAdmin.png
Binary file added build/html/_images/resourcesAdminEditWorkflow.png
Binary file added build/html/_images/resourcesAttachments.png
Binary file added build/html/_images/resourcesCataloging.png
Binary file added build/html/_images/resourcesContacts.png
Binary file added build/html/_images/resourcesEditAccess.png
Binary file added build/html/_images/resourcesEditAcquistion.png
Binary file added build/html/_images/resourcesEditCataloging.png
Binary file added build/html/_images/resourcesEditLicenses.png
Binary file added build/html/_images/resourcesEditResource.png
Binary file added build/html/_images/resourcesEditUser.png
Binary file added build/html/_images/resourcesFileImport.png
Binary file added build/html/_images/resourcesHome.png
Binary file added build/html/_images/resourcesMyQueue.png
Binary file added build/html/_images/resourcesProduct.png
Binary file added build/html/_images/resourcesRouting.png
Binary file added build/html/_images/viewicon.png
18 changes: 16 additions & 2 deletions build/html/_sources/docstyleguide.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,22 @@ The purpose of the style guide is to help keep the documentation consistent in s
### Setting Up ###

The CDP is managed in a repo on GitHub found at [https://github.com/Coral-erm
](https://github.com/Coral-erm "https://github.com/Coral-erm "). The project uses the [Sphinx Python Documentation Generator](http://www.sphinx-doc.org/en/stable/) and [CommonMark](http://commonmark.org/). The documentation files are edited in a combination of [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) and [Markdown](https://en.wikipedia.org/wiki/Markdown), both markup languages supported by GitHub. In addition, [Read the Docs](https://readthedocs.org/) is used for hosting the documentation and providing additional documentation conversion and indexing tools.
](https://github.com/Coral-erm "https://github.com/Coral-erm "). The project uses the [Sphinx Python Documentation Generator](http://www.sphinx-doc.org/en/stable/) and [ReCommonMark](http://recommonmark.readthedocs.io/en/latest/). The documentation files are edited in a combination of [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) and [Markdown](https://en.wikipedia.org/wiki/Markdown), both markup languages supported by GitHub. In addition, [Read the Docs](https://readthedocs.org/) is used for hosting the documentation and providing additional documentation conversion and indexing tools.


### Documentation Versioning ###
### File Structure and File Naming Conventions ###

#### Images ####

1) Create a subfolder under /img using the same name as the markdown file in which the images will be used.

For example, the following folder name for organizations.md

/img/organizations/


2) Add images to the subfolder created in step 1. Name the images with a prefix identifying the markdown file they are associated with, separated Uppercase letters with a brief description of the image. Note: The underscore character causes GitHub to incorrectly process the image filenames in Markdown, which leads to problems in building files in the ReadtheDocs.

For example: **organizationsAccountsView.png** for a a screenshot of the Organization's module accounts form.


4 changes: 3 additions & 1 deletion build/html/_sources/gokb.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,6 @@ Resource's identifier of provider*

Package content customization

You can personalize package content once it is imported. You can also custom package you already got even if it was not imported from GOKb. The "custom screen" display the current package's children. If the checkbox is checked: the resource will be kept, else it will be removed from database when you will click on 'Confirm customization' button.
You can personalize package content once it is imported. You can also custom package you already got even if it was not imported from GOKb. The "custom screen" display the current package's children. If the checkbox is checked: the resource will be kept, else it will be removed from database when you will click on 'Confirm customization' button.

This is a test!!!
1 change: 1 addition & 0 deletions build/html/_sources/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ CORAL Documentation Project
licensing
organizations
usagestats
management
technical
glossary
faq
Expand Down
Loading