[FOLIO-404] Onboarding documentation Created: 10/Nov/16  Updated: 18/Jan/19

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

Type: Task Priority: P3
Reporter: Mike Taylor Assignee: Peter Murray
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: 15 minutes
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-410 Perform Code4Lib Tutorial - 6-Mar-2017 Closed
Relates
relates to FOLIO-366 Commence a new document to assist wit... In Progress
relates to FOLIO-390 Add high-level documentation for foli... Closed
relates to STRIPES-92 Onboarding/overview documentation for... Closed
Sprint:
Development Team: Core: Platform

 Description   

We need a "Welcome to becoming a FOLIO developer" document with a very high-level introduction to what the parts are, what value they bring and how the fit together – and linking to the various lower-level documents.

It's not clear yet who will write that.



 Comments   
Comment by Peter Murray [ 10/Nov/16 ]

I've been looking at Dive into Hydra as a model for something like this. Is this issue Stripes-specific, or is it the full stack of an app?

Comment by Mike Taylor [ 10/Nov/16 ]

Thanks, Peter. Maybe we should assign this to you for now?

I think the scope goes beyond UI development – we don't really want separate orientation routes for front-end and back-end developers, especially as they will likely be often the same people.

Comment by Peter Murray [ 10/Nov/16 ]

I'm happy to take this ticket, and I agree that it is best if the scope includes both UI and server module development. This is something that will need to be in place by the Code4Lib workshop in early March.

Comment by Mike Taylor [ 17/Nov/16 ]

Hmm. Having forgotten this discussion, I filed STRIPES-92 Closed earlier today, expecting to write it myself. Not sure what to do now. I guess we could close one of them as a duplicate. But, Peter, do you have enough in-depth understanding of Stripes to write this?

Comment by Peter Murray [ 17/Nov/16 ]

No – not nearly enough to write the body of it. I think I do have enough, though, to create an outline and the basic text that others can come in and augment with specific knowledge.

Comment by Mike Taylor [ 17/Nov/16 ]

Well, since I'll be filling in all the details, is there any value in having you write the skeleton? Shall we just close this one as a dup of 92?

Comment by Peter Murray [ 17/Nov/16 ]

It's not just the UI pieces, though. The onboarding documentation will also need information about writing the backend services, too. Perhaps the task is too general for a STRIPES project issue?

Comment by Mike Taylor [ 17/Nov/16 ]

OK, how about this. You keep this issue, and move it to FOLIO rather than STRIPES. Then make STRIPES-92 Closed a blocker for it. I'll do that bit, and you can have (or delagate) the rest. Sound good?

Comment by David Crossley [ 17/Nov/16 ]

I have linked some other related issues.

There are also some basic development tips in folio-sample-modules/README.md which could be consolidated.

Comment by Peter Murray [ 05/Dec/16 ]

Excellent suggestion, Mike Taylor – and thank you for the links to the related issues, David Crossley.

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