diff --git a/packages/component-app/README.md b/packages/component-app/README.md new file mode 100644 index 0000000000000000000000000000000000000000..fe1d240b7446b33e2dca5448cf200a8f3efc0802 --- /dev/null +++ b/packages/component-app/README.md @@ -0,0 +1,6 @@ +## component-app + +The aim of this package is to group things that are shared by apps. + +*Note: +To be moved back into xpub-collabra.* \ No newline at end of file diff --git a/packages/component-authentication/README.md b/packages/component-authentication/README.md new file mode 100644 index 0000000000000000000000000000000000000000..779ea8cce0b65d325f62b47818c6450a36602eee --- /dev/null +++ b/packages/component-authentication/README.md @@ -0,0 +1,6 @@ +## pubsweet-component-authentication + +A module containing all the PubSweet components needed for authentication. This module uses UI elements from `pubsweet-ui` and brings in the currentUser reducer from `pubsweet-client` so that all the authentication-related redux code is in the same place. A `PrivateRoute` component is used to ensure that the current user is authenticated and loaded before a page is rendered. + +*Note: +This should be merged with the default authentication components provided by pubsweet.* diff --git a/packages/component-dashboard/README.md b/packages/component-dashboard/README.md new file mode 100644 index 0000000000000000000000000000000000000000..86927e3e17babcfac769bf08c1f101cad922ffca --- /dev/null +++ b/packages/component-dashboard/README.md @@ -0,0 +1,3 @@ +## pubsweet-component-xpub-dashboard + +A PubSweet component that provides the xpub dashboard, listing submissions that are available for the current user to take action on. \ No newline at end of file diff --git a/packages/component-manuscript/README.md b/packages/component-manuscript/README.md new file mode 100644 index 0000000000000000000000000000000000000000..c2b31a831f9fb146c8fbfb2adb787ebc76430cca --- /dev/null +++ b/packages/component-manuscript/README.md @@ -0,0 +1,6 @@ +## pubsweet-component-xpub-manuscript + +A PubSweet component that provides the interface for an author to edit their manuscript. + +*Note: +To be replaced with `pubsweet-component-wax` once the issue with routing parameters is sorted out (currently Editoria uses "bookId" in routes while xpub uses "projectId" -- see [here](https://gitlab.coko.foundation/pubsweet/pubsweet-components/issues/56) for a proposal around this).* \ No newline at end of file diff --git a/packages/component-review/README.md b/packages/component-review/README.md new file mode 100644 index 0000000000000000000000000000000000000000..c7c1d43eeab7e1f375661d8c6dc118ab26d02fc3 --- /dev/null +++ b/packages/component-review/README.md @@ -0,0 +1,6 @@ +## pubsweet-component-xpub-review + +A PubSweet component that provides interfaces for editors to invite reviewers, reviewers to submit their reviews, and editors to make their decisions. + +*Note: +Some of the container components for these pages are a bit complex, as they need to also connect child components that are nested deeper in the tree and pass them down as props - there may be a better solution to this.* diff --git a/packages/component-submit/README.md b/packages/component-submit/README.md new file mode 100644 index 0000000000000000000000000000000000000000..a6751bcc4574625a85d3acac0ab4932b66e61c5e --- /dev/null +++ b/packages/component-submit/README.md @@ -0,0 +1,6 @@ +## pubsweet-component-xpub-submit + +A PubSweet component that provides the form which the author completes before submitting a manuscript. It uses redux-form to handle the form state. + +*Note: +The previously-released version of this component used JSON configuration to describe the form, and that can be implemented here too, once we know more about the types of input that are needed in submission forms for other journals.* \ No newline at end of file diff --git a/packages/xpub-bootstrap/README.md b/packages/xpub-bootstrap/README.md new file mode 100644 index 0000000000000000000000000000000000000000..4cee61c1371fda2f63c1af4056bbd0bc4895687c --- /dev/null +++ b/packages/xpub-bootstrap/README.md @@ -0,0 +1,3 @@ +## xpub-bootstrap + +Support for Bootstrap, in case any xpub apps want to use a PubSweet component that relies on Bootstrap being present. \ No newline at end of file diff --git a/packages/xpub-collabra/README.md b/packages/xpub-collabra/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6d156517e176002016bb637f481f86f59e3d3479 --- /dev/null +++ b/packages/xpub-collabra/README.md @@ -0,0 +1,3 @@ +## xpub-collabra + +An MVP implementation of the first design sessions with [Collabra Psychology](https://www.collabra.org/), which allows a user to go through the process of creating a submission, assigning editors and reviewers, submitting reviews and submitting a decision. \ No newline at end of file diff --git a/packages/xpub-connect/README.md b/packages/xpub-connect/README.md new file mode 100644 index 0000000000000000000000000000000000000000..febc4ed48f6adfc7907289ff96af7dd5b9dd2b16 --- /dev/null +++ b/packages/xpub-connect/README.md @@ -0,0 +1,3 @@ +## xpub-connect (pubsweet-connect) + +This allows components to be defined as part of the composition of a functional component (as an alternative to handling data dependencies in the react lifecycle). diff --git a/packages/xpub-edit/README.md b/packages/xpub-edit/README.md new file mode 100644 index 0000000000000000000000000000000000000000..98679ff9ec9cecaf28381d514d7d55fa63027222 --- /dev/null +++ b/packages/xpub-edit/README.md @@ -0,0 +1,6 @@ +## xpub-edit (pubsweet-edit) + +A configurable editor built with ProseMirror, allowing rich-text form inputs to have a defined schema and custom toolbars. + +*Note: +This will be moved to pubsweet.* diff --git a/packages/xpub-journal/README.md b/packages/xpub-journal/README.md new file mode 100644 index 0000000000000000000000000000000000000000..455b07e7e52856beed32e790112f2305517e3d53 --- /dev/null +++ b/packages/xpub-journal/README.md @@ -0,0 +1,7 @@ +## xpub-journal + +`xpub-collabra` is built for a single journal. As there was no place for a journal in the data model, the journal configuration is passed into the app via this JournalProvider component. + +*Note: +This will probably need to be replaced by journal configuration in the database, in order to support multiple journals in xpub apps. +To be revisited after we make a more final decision on xpub's data model.* diff --git a/packages/xpub-selectors/README.md b/packages/xpub-selectors/README.md new file mode 100644 index 0000000000000000000000000000000000000000..fe84572de74199db1cca3a0374834d98597d449a --- /dev/null +++ b/packages/xpub-selectors/README.md @@ -0,0 +1,6 @@ +## xpub-selectors + +Helper functions for common selectors used in redux compose, so that components don't need to know the unique shape of each part of the store. + +*Note: +Some of these selectors will probably move to `pubsweet-client`.* \ No newline at end of file diff --git a/packages/xpub-upload/README.md b/packages/xpub-upload/README.md new file mode 100644 index 0000000000000000000000000000000000000000..aeb2f00603d16fa9f481b63b535f44f3b957fdcc --- /dev/null +++ b/packages/xpub-upload/README.md @@ -0,0 +1,3 @@ +## xpub-upload +A helper function for uploading a file. +To be removed once [this](https://gitlab.coko.foundation/pubsweet/pubsweet-client/merge_requests/79/) is implemented in pubsweet-client. diff --git a/packages/xpub-validators/README.md b/packages/xpub-validators/README.md new file mode 100644 index 0000000000000000000000000000000000000000..d3e49e3d04d633c299dc1351cbc8046656c2fe29 --- /dev/null +++ b/packages/xpub-validators/README.md @@ -0,0 +1,6 @@ +## xpub-validators + +Common validator functions for form fields, for use with `redux-form`. + +*Note +Likely generic enough to be moved to the pubsweet repo.*