Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
gargantext
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
humanities
gargantext
Commits
898b5078
Commit
898b5078
authored
Apr 29, 2016
by
c24b
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs +1
parent
d61e6d71
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
73 additions
and
0 deletions
+73
-0
contribution.md
docs/contribution.md
+57
-0
docs_readme.md
docs/docs_readme.md
+5
-0
tuto.md
docs/tuto.md
+11
-0
No files found.
docs/contribution.md
0 → 100644
View file @
898b5078
#Contribution guide
## Community
*
[
http://gargantext.org/about
](
http://gargantext.org/about
)
*
IRC Chat: (OFTC/FreeNode) #gargantex
##Tools
*
gogs
*
server access
*
gargantext box
##Gargantex
*
Gargantex box install
(S.I.R.= Setup Install & Run procedures)
*
Architecture Overview
*
Database Schema Overview
*
Interface design Overview
##To do:
*
Docs
*
Interface deisgn
*
Parsers/scrapers
*
Computing
## How to contribute:
1.
Clone the repo
2.
Create a new branch
<username>
-refactoring
3.
Run the gargantext-box
4.
Code
5.
Test
6.
Commit
### Exemple1: Adding a parser
*
create your new file cern.py into gargantex/scrapers/
*
reference into gargantex/scrapers/urls.py
add this line:
import scrapers.cern as cern
*
reference into gargantext/constants
```
# type 9
{ 'name': 'Cern',
'parser': CernParser,
'default_language': 'en',
},
```
*
add an APIKEY in gargantex/settings
### Exemple2: User Interface Design
docs/docs_readme.md
0 → 100644
View file @
898b5078
*
Referencer ses pages dans mkdocs.yml
*
Ecrire chaque fichier en markdown (github flavor)
*
Générer la doc create-dic.sh > génére un dossier site
*
[
RTFM
](
http://www.mkdocs.org/
)
!
docs/tuto.md
View file @
898b5078
#User guide
1.
Login
run the gargantex box following the install procedure
open a webrwoser at http://127.0.0.1:8000/
click on Test Gargantext
login with:
```
Login : gargantua
Password : autnagrag
```
2.
Create a project
3.
Import an existing corpus
4.
create corpus
5.
Explore
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment