[FOLIO-275] Need an overview introduction to the repos, platform, demos Created: 31/Aug/16  Updated: 12/Nov/18  Resolved: 02/Sep/16

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Bug Priority: P2
Reporter: RonB Assignee: Peter Murray
Resolution: Done Votes: 1
Labels: None
Remaining Estimate: 4 hours
Time Spent: 3 hours, 30 minutes
Original estimate: Not Specified

Sprint:

 Description   

Assuming that the majority of audience is 1) early adopters looking to install/poke/look at platform, and 2) interested app module developers.

folio-org.github.io/source-code/ needs a real intro... something like:

0. Release status i.e. be honest with the expectation that this is not even an alpha/beta, no 1 click install yet (its 10 diff repos now with no script install).

1. Lower-level diagram of the parts/components (e.g. https://raw.githubusercontent.com/folio-org/okapi/master/doc/module_management.png). Overlay/sync with the marketing diagram (e.g. folio.org/platform/)

2. First build OKAPI, review the documentation

3. Suggested next steps to kick the tires
a. raml
b. pull base mods: config, auth, metadata first
c. then mod demos: circ, acq
c. stripes UI toolkit
d. other tests



 Comments   
Comment by Mike Taylor [ 01/Sep/16 ]

I feel that this is now in a much better state:
http://dev.folio.org/source-code/

I am not closing the issue yet because it would be good to come back at some less frazzled point and add the suggested "next steps" section.

Comment by RonB [ 01/Sep/16 ]

http://dev.folio.org/source-code/ — Some spelling fixes needed in the latest edits. This sentence:
"The FOLIO source code is split several repositories, all of them on GitHub in the folio-org area. The fall into three categories:"

4th paragraph also seems to duplicate the 2nd.

Comment by Mike Taylor [ 01/Sep/16 ]

Thanks. Fixed.

Comment by Mike Taylor [ 01/Sep/16 ]

Peter has more ideas for this, so I handed it over to him.

Comment by Peter Murray [ 01/Sep/16 ]

I've made a pass through this and made some editorial changes. Does this look better to you RonB?

Comment by RonB [ 01/Sep/16 ]

Looks good.

An additional thought... this line might come across too negative - "PLEASE NOTE that this code is not mature. It is not yet even at the level of and alpha release, and should be considered a technology preview only, in accordance with the release early, release often philosophy."

Maybe we could shorten and soften it a bit to something like "PLEASE NOTE that this is a technology preview following the release early, release often philosophy."

Comment by Mike Taylor [ 01/Sep/16 ]

Thanks, Ron: fixed as you suggest.

Comment by Peter Murray [ 02/Sep/16 ]

RonB - Okay to close from your perspective?

Comment by RonB [ 02/Sep/16 ]

Yes thanks

Generated at Thu Feb 08 23:04:35 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.