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

Document existing plugins using docma #1300

Closed
3 tasks
mbarto opened this issue Nov 28, 2016 · 2 comments
Closed
3 tasks

Document existing plugins using docma #1300

mbarto opened this issue Nov 28, 2016 · 2 comments
Assignees
@offtherailz
Labels
enhancement user story
Milestone
2017.02.00 (Custo...

Comments

@mbarto
Copy link
Contributor

mbarto commented Nov 28, 2016 •
edited by offtherailz
Loading

We should document the existing plugins, for each of them:

  • available configuration properties, with explanation of usage
  • available containers (Toolbar, DrawerMenu, etc.) and related configuration options
  • styles / css
  • examples of usage

This should be done using proper JSDOC syntax (see http://usejsdoc.org/howto-commonjs-modules.html)
@mbarto mbarto added this to the R52016 milestone Nov 28, 2016
@mbarto mbarto mentioned this issue Nov 28, 2016
Closed
@mbarto mbarto changed the title Document existing plugins on the wiki Document existing plugins using doclets Dec 1, 2016
@offtherailz
Copy link
Member

offtherailz commented Dec 16, 2016 •
edited
Loading

We should follow a structure like this for the jsdoc + some pages that describe how to build, create application etc...

image
@mbarto comments?

I'm not sure if we can map proptypes. But maybe we can place it manually in the global module description... we should use a trial-and-error approach

@Gnafu Gnafu modified the milestones: R12017, R52016 Jan 19, 2017
@simboss
Copy link
Member

simboss commented Mar 9, 2017

What do we do?

@offtherailz offtherailz self-assigned this Mar 13, 2017
@offtherailz offtherailz changed the title Document existing plugins using doclets Document existing plugins using docma Mar 13, 2017
@offtherailz offtherailz mentioned this issue Mar 13, 2017
Merged
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

@offtherailz offtherailz

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

No branches or pull requests
5 participants
@simboss @offtherailz @mbarto @Gnafu @saidaipparla