[FOLIO-359] Document each new repository at dev.folio.org/source-code/ Created: 25/Oct/16  Updated: 18/Nov/20  Resolved: 18/Nov/20

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

Type: New Feature Priority: P3
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: devdoc
Remaining Estimate: Not Specified
Time Spent: 2 days, 2 hours, 40 minutes
Original estimate: Not Specified

Sprint:
Development Team: FOLIO DevOps

 Description   

As new repositories are created, list them.



 Comments   
Comment by David Crossley [ 26/Oct/16 ]

Listed stripes-core and stripes-connect which were split from stripes-experiments.

Not yet added the new stripes-components.

Comment by David Crossley [ 15/Nov/16 ]

Added stripes-components and folio-ansible and folio-org.github.io

Comment by David Crossley [ 15/Nov/16 ]

Added ui-okapi-console

Comment by David Crossley [ 24/Nov/16 ]

Added ui-users

Comment by David Crossley [ 28/Dec/16 ]

Added cql2pgjson-java

Comment by David Crossley [ 03/Mar/17 ]

Added mod-users-bl, mod-loan-storage, stripes-logger, ui-scan

Comment by David Crossley [ 21/Mar/17 ]

Added stripes-sample-platform

Comment by David Crossley [ 15/Aug/17 ]

Added mod-notes.
Added stripes-redux ui-form ui-requests.
Replaced ui-scan with ui-checkin and ui-checkout.

Comment by David Crossley [ 15/Nov/17 ]

Not explicitly commenting here any more. The commits are auto-linked.

Comment by David Crossley [ 05/May/20 ]

Over the years, i have manually maintained the list (at https://dev.folio.org/source-code/) by listing new repositories, and following any renaming and archiving. (See commit messages and PRs using this ticket number FOLIO-359 Closed .)

That was never sustainable. Also the page has become unwieldy.

So for a while now i have been developing a way to automate the listing, enable it to be divided into sections, and to link to other relevant documentation for each module.

Recently the FOLIO Wiki has gained sections for User Tips, and App Settings, for each front-end module.

Comment by David Crossley [ 05/May/20 ]

Today added a new page https://dev.folio.org/source-code/map/

This is a major move towards automating this source-code documentation.
See pull/557

The way that it is assembled and maintained is documented at https://dev.folio.org/source-code/map/#further-information

This new index enables developers to easily navigate to API documentation (and the reverse) and to relevant further documentation for each module.

Comment by David Crossley [ 05/May/20 ]

The next stage is to trim the main page to remove the explicit listings of each repository, and instead link to relevant sections of this automated index.

Note that some repositories are still missing their GitHub "Description", so some words may need to be utilised over there, or in the supplemental descriptions enabled by this new index. (Important fodder for the site search system.)

Comment by David Crossley [ 18/Nov/20 ]

Done

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