Skip to content

Writing epics dev guide#3394

Merged
offtherailz merged 12 commits intogeosolutions-it:dev_guidefrom
offtherailz:writing-epics
Dec 18, 2018
Merged

Writing epics dev guide#3394
offtherailz merged 12 commits intogeosolutions-it:dev_guidefrom
offtherailz:writing-epics

Conversation

@offtherailz
Copy link
Copy Markdown
Member

Writing epics. Dev guide: first part

Copy link
Copy Markdown
Contributor

@mbarto mbarto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work.
Some suggestions inline.
If you plan to add more content, I would concentrate on examples of use cases we encounter in the current codebase.
I would also refer external documentation where possible: it's good to have a basic introduction on the concepts, but then I would delegate to existing documentation.


### Versions

At the time of writing this documentation MapStore2 are using RxJS 5.1.1 and redux-observable 0.13.0.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not confuse the developer with too many details, just a note on the versions we use (and the link to the official documentation for those is enough in my opinion).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but I'm afraid the original documentation will disappear soon, so I'd like to provide at least some basic information about how to read the actual code to posterity :).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope the documentation of older versions will remain, maybe it will be more difficult to find them. If they are going to disappear, blame to the RxJS project. In any case, I am looking for a compromise: can we move this libraries-related docs to different page and link it from here?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hehe, I use to skip details I'm not interested, but if you think it's confusing, I'll remove it.

mbarto and others added 11 commits December 7, 2018 10:47
Co-Authored-By: offtherailz <offtherailz@gmail.com>
Co-Authored-By: offtherailz <offtherailz@gmail.com>
Co-Authored-By: offtherailz <offtherailz@gmail.com>
Co-Authored-By: offtherailz <offtherailz@gmail.com>
Co-Authored-By: offtherailz <offtherailz@gmail.com>
Co-Authored-By: offtherailz <offtherailz@gmail.com>
Co-Authored-By: offtherailz <offtherailz@gmail.com>
Co-Authored-By: offtherailz <offtherailz@gmail.com>
Co-Authored-By: offtherailz <offtherailz@gmail.com>
@offtherailz offtherailz merged commit 3639d51 into geosolutions-it:dev_guide Dec 18, 2018
offtherailz added a commit that referenced this pull request Apr 12, 2019
* Epics dev guide - first part (#3394)

* Fixes #3454 plugins developers documentation
@offtherailz offtherailz deleted the writing-epics branch May 26, 2020 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants