Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Write documentation for: #15

Open
32 of 42 tasks
ncovercash opened this issue Jun 1, 2023 · 0 comments
Open
32 of 42 tasks

Write documentation for: #15

ncovercash opened this issue Jun 1, 2023 · 0 comments
Assignees

Comments

@ncovercash
Copy link
Member

ncovercash commented Jun 1, 2023

  • ensure vscode/sonar up to date
  • update vagrant docs
  • combine docs/new-development-setup into training folder
  • update docs/style guide for single quotes and stripes workspace instructions
  • update rancher docs (off period)
  • how to release
  • overall guide to test types/purposes
  • overall guide to how Okapi manages things/modules/structure/permissions/API versions
  • overall guide on Stripes pieces
  • jenkins/github actions

backend:

  • prereqs
  • openapi
    • using api-doc
  • liquibase/repository/mapstruct
  • unit testing (hamcrest, parameterized)
  • integration testing
  • supplemental
    • lombok
    • karate
    • spring components/beans/service/controller/etc/architecture
    • spring batch bits
    • log4j
    • okapi module descriptor (info only?)

frontend:

  • prereqs/setting up module
  • setup full platform
  • intro to react
    • react's sample tic tac toe thing
    • convert to functional
    • convert to typescript
  • using stripes-components/intro to FOLIO UX
  • using jest (coverage, .each, etc)
  • using RTL
  • more advanced typescript
  • 05: react-final-form, a way of intelligently handling react forms so state doesn't stab you in the back — this would let us sketch out a "create institution form"
  • 06: react-query mutations, which lets you use the same react-query conveniences to send API requests to edit/create/delete data in a performant way — this will make the form actually save to the server
  • 07: react-intl localization — this is a bit of a tangent, but very important since this is used around the globe
  • 08: more of an exploratory thing to try adding features to edit and delete institutions, would not be a new technology but rather further practice

then supplementals on:

  • the stripes god-object
  • cypress (I'm not qualified to write this, but someone should eventually)
  • using react-final-form-arrays
  • some notes about the FOLIO platform/dependency management
  • using react-router-dom
@ncovercash ncovercash self-assigned this Jun 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant