Bug 564527

Comment 1 Elena Parovyshnaia 2020-09-08 08:57:33 EDT

To be done for 1.1.0

Comment 2 Rolf Theunissen 2021-05-27 04:50:15 EDT

Any update on the documentation? The project seems ready to release version 2.0.0, but there is still no user documentation at all.
The project seems very interesting, but without any documentation it is not even possible to judge if the tool is usable for my use cases.


The bits and pieces that are out there are all already outdated, for example:
- Website, mentions '1.0.0 (in progress)' while 1.2.1 is released and 2.0.0 is in progress. https://www.eclipse.org/passage/
- Wiki, https://wiki.eclipse.org/Passage is more or less a placeholder. https://wiki.eclipse.org/Passage/FAQ mentions only release 0.4.0-RC1.
- Forum, one single request for documentation, no answer. https://www.eclipse.org/forums/index.php/f/449/

https://projects.eclipse.org/projects/technology.passage Mentions a workflow, but this is more the sales pitch then how to use the product.

https://github.com/eclipse-passage/passage#readme only mentions to 'just' include a feature and then everything magically works.

Comment 3 Elena Parovyshnaia 2021-05-27 07:01:41 EDT

Dear Rolf.

On behalf of Passage team I thank you for using Passage. 

It's true that documentation is poor, but I'm eager to create sufficient instructuins for your needs. Let's just create a short list of questions for me to answer. 

There are four phases in licensing of a product with Passage:

 1. Done by product development
  - should declare what in the product is protected by license (it can be the whole product or/and some particular features). Here we have working examples and I will guide you through. 
  - should implant license checks in proper points in the product codebase. This is done easily with several linse of code with Passage API utilized. Will supply workable examples.  ​

 ​From this point the product is treated as protected  by Passage.
​ Now we need to issue a license for our product to  make Passage let ua user to use the product. This is done with two steps.

​2. Done by product management 
 - should create licensing metadata for the product: define product, features and their versions under licensing protection, generate encryption keys, create license plan. 
These step betegs several artifacts (now xmi files) that are quite prescious and should be kept with care. 

3. Done by sales management
 - license issuing boils down to a simple wizard passing which ends up by a pack of license files storing on a file system. 

4. Done by doc team 
 - this step is done by the product's user, but should definitely be documented: when a user gets your product and a license, how they should apply the license to the product. 

Does it look to you as a complete set of questions to cover?

Comment 4 Rolf Theunissen 2021-05-27 09:07:49 EDT

Thanks for you answer.

I think that this covers the basics. I was mainly looking how to integrate it in a product, which would be covered by point 1.
I assume that some of the artifacts generated in point 2 should be included in the product too.

For now we are also in a small team, so the product development, product management, sales management and documentation team would all be the same team. I suggest that the documentation is less oriented on the team that does the work, but rather on the kind of activities that are executed. Then it is free to the users of Passage to map these activities to teams.

Comment 5 Elena Parovyshnaia 2021-05-31 08:21:48 EDT

Until http://eclipse-passage.github.io/passage-docs does not work yet, current state of the documentation (not finished) can be accessed at http://arsysop.ru/passage/html/dev-guide.html

Comment 6 Elena Parovyshnaia 2021-05-31 12:12:22 EDT

Development guide is complete.

Comment 7 Alexander Fedorov 2021-06-16 11:50:25 EDT

Partially done, moving the rest to the next release

Comment 8 Elena Parovyshnaia 2021-11-23 01:24:49 EST

All related subtasks are done, scarce are moved to Passage GitHub.

Keep an eye on Documnetation conponent [2].

[1] https://github.com/eclipse-passage/passage/issues
[2] https://github.com/eclipse-passage/passage/issues?q=is%3Aissue+is%3Aopen+label%3Acomponent%3A%3Adocumentation