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.

Sign up for GitHub

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

Jump to bottom

Investigate on react-docgen to create reference docs #1475

Closed
mbarto opened this issue Feb 16, 2017 · 1 comment
Closed

Investigate on react-docgen to create reference docs #1475

mbarto opened this issue Feb 16, 2017 · 1 comment
Assignees
@fernandinand @offtherailz
Labels
enhancement investigation
Milestone
2017.02.00 (Custo...

Comments

@mbarto
Copy link
Contributor

mbarto commented Feb 16, 2017

react-docgen is a library to create docs from react components in JSON format.

Other tools exist to create markdown from this JSON:

We have to create a workflow to:

  • generate reference docs for our plugins (and components)
  • save them in MD format, in the docs/developer-guide/reference folder so that they become part of the github pages website
  • create an index of files for the docs/developer-guide/reference folder

Let's start documenting ONE plugin properly (e.g. MousePosition) and creating docs for it
@mbarto mbarto added this to the 2017.02.00 milestone Feb 16, 2017
fernandinand added a commit to fernandinand/MapStore2 that referenced this issue Feb 20, 2017
@fernandinand
geosolutions-it#1475 Create markdown reference docs from react-docgen…
bfcf52c 
… output
fernandinand added a commit to fernandinand/MapStore2 that referenced this issue Feb 21, 2017
@fernandinand
geosolutions-it#1475 genDocs script to generate MD document files fro…
ec2e1a6 
…m react-docgen output
fernandinand added a commit to fernandinand/MapStore2 that referenced this issue Feb 21, 2017
@fernandinand
geosolutions-it#1475 Missing dummy index.md file
0bc3cf7
fernandinand added a commit to fernandinand/MapStore2 that referenced this issue Feb 23, 2017
@fernandinand
geosolutions-it#1475 Changes required on PR comments
7fb0c46
fernandinand added a commit to fernandinand/MapStore2 that referenced this issue Feb 27, 2017
@fernandinand
geosolutions-it#1475 Build TOC entry manually
8ebbf52
@offtherailz
Copy link
Member

We may check docma instead

@offtherailz offtherailz mentioned this issue Mar 13, 2017
Merged
@ghost ghost assigned offtherailz Mar 13, 2017
@ghost ghost removed the pending review label Mar 13, 2017
offtherailz added a commit that referenced this issue Mar 13, 2017
@offtherailz
Fix #1475 documentation with docma (#1539)
fa7095c 
Fix #1475. Add documentation using docma:

gets markdown from docs dir
gets jsdoc from reducers, actions, epics, components and plugins
create a single page application to deploy inside mapstore2 directly
Fixes #1300 documenting some plugins, together with actions, reducers, epics
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fernandinand fernandinand

@offtherailz offtherailz

Labels
enhancement investigation
Projects
None yet
Milestone
2017.02.00 (Custom Theme)
Development

No branches or pull requests
3 participants
@fernandinand @offtherailz @mbarto