Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: move docs to separate folder #1604

Merged
merged 1 commit into from
Feb 26, 2020
Merged

chore: move docs to separate folder #1604

merged 1 commit into from
Feb 26, 2020

Conversation

chanceaclark
Copy link
Contributor

@chanceaclark chanceaclark commented Feb 24, 2020 •
edited
Loading

What

This PR is more of a proposal, in which I will outline below:

To get the repo into a state where we can effectively use TypeScript, I propose we use separation of concerns for the individual aspects of the repo. With this in mind we would be able to split the load on converting each package individually instead of an all at once approach. This would allow us to slowly convert to Typescript. Proposal (not in any particular order, unless noted):

  • Move docs/ into it's own package folder.
  • Add configs package, for shared dev deps configs (i.e. eslint, babel, tsconfig, etc...).
  • Move playground/ into it's own package folder.
    • Convert to NextJS (Optional/further discussion needed). This would probably fall later in the process.
  • Convert Webpack to Rollup. I think this might simplify the build process. Converting to Next would also benefit this step.

If this is related to existing tickets, include links to them as well.
#1532, #1409, #583

ping @epicfaace

@epicfaace
Copy link
Member

Thanks for bringing this up. A few thoughts:

  • What's the need for a separate package for docs?
  • I did some work on creating a @rjsf/playground package in Combine all themes into a single playground #1539, but got stuck because it wasn't able to build the playground package. Let me know if you could take a look and have any idea what may fix it!

@chanceaclark
Copy link
Contributor Author

chanceaclark commented Feb 25, 2020 •
edited
Loading

  • What's the need for a separate package for docs?

Just to keep the core/ package only for main functionality. Essentially just separation of concerns.

  • I did some work on creating a @rjsf/playground package in Combine all themes into a single playground #1539, but got stuck because it wasn't able to build the playground package. Let me know if you could take a look and have any idea what may fix it!

Let me take a stab at it and see what I can do!

EDIT: @epicfaace looks like you already beat me to it!

@epicfaace
Copy link
Member

Just to keep the core/ package only for main functionality. Essentially just separation of concerns.

Right, makes sense. I'm wondering why it should be in packages, though; perhaps it should be in the root directory instead?

@chanceaclark
Copy link
Contributor Author

Right, makes sense. I'm wondering why it should be in packages, though; perhaps it should be in the root directory instead?

Good call! We should assume that any folder inside packages contains a package.json. I'll make that adjustment.

epicfaace
epicfaace requested changes Feb 26, 2020
View reviewed changes
docs/mkdocs.yml Show resolved Hide resolved
@epicfaace epicfaace merged commit b7ef383 into rjsf-team:master Feb 26, 2020
@chanceaclark chanceaclark deleted the chore/move-docs branch February 26, 2020 21:14
erunion added a commit to readmeio/react-jsonschema-form that referenced this pull request Feb 27, 2020
@erunion @epicfaace
@89erik @ACoolmanBigHealth @estin @chanceaclark
chore: update our fork with the latest upstream (#3)
cd2ee34 
* update package lock

* v2.0.0-alpha.2

* Overridable DescriptionField in BooleanField (rjsf-team#1594)

* Overridable description field in BooleanField

* Adds test for BooleanField's overridable DescriptionField

* doc: JSON schema version supported versions (rjsf-team#1603)

For rjsf-team#1307 (comment)

* Don't crash when schema property is a non-object - show an error instead (rjsf-team#1582)

* don't throw TypeError: Cannot use 'in' operator to search for

* Update Form_test.js

Co-authored-by: Ashwin Ramaswami <[email protected]>

* Set up CI with Azure Pipelines (rjsf-team#1605)

* Set up CI with Azure Pipelines

[skip ci]

* Update azure-pipelines.yml for Azure Pipelines

* Add npm test to azure pipelines

* Delete .travis.yml

* Combine all themes into a single playground (rjsf-team#1539)

* move playground to new folder

* move playground to packages and standardize playground structure

* don't rely on bootstrap in playground

* fix styling, move share button to top right

* remove footer things

* more fixes

* encode theme in playground hash

* fix: don't switch to default theme when changing tabs

* correct package name is @rjsf/playground

* fix prod config for playground

* fix more configs

* use webpack-dev-server

* render form in a Frame

* add dependencies

* use DemoFrame component to properly fix material-ui styles

* use old bootstrap look and feel for the playground itself

* fix dist

* move netlify toml

* update netlify

* empty commit

* remove npm prepare to speed up travis runs

* fix webpack dist config for playground

* fix import

* disable minicssextractplugin to try to fix netlify

* fix netlify path

* no need to build playground / gh-pages for core package

* add HtmlWebpackPlugin

* Allow references that don't start with #/definitions/ (rjsf-team#1506)

* pass entire rootSchema to findSchemaDefinition, not just definitions

* use jsonpointer to handle non-"#/definitions" definitions

* revert package-lock

* make sure json pointers are URI fragment encoded

* replace "definitions" with "rootSchema"  variable

* Fix getMatchingOption logic

* fix tests

* remove console log

* Fix tests

* prettier

* Remove support for recursive references to deep schema definitions

* update docs for registry and definitions

* add `definitions` back to registry

* Fix mui form tests

* Add a general registry test

* update proptypes of registry

* fix eslint issues

* fix formatting

* Fix local playground for core package (rjsf-team#1607)

* remove scss file from playground

* fix dev playground on @rjsf/core

* fix playground version

* update package-lock

* fix playground "npm start"

* chore: move docs to separate folder (rjsf-team#1604)

* test: adding a github workflow for running tests

Co-authored-by: Ashwin Ramaswami <[email protected]>
Co-authored-by: Erik Lothe <[email protected]>
Co-authored-by: ACoolmanBigHealth <[email protected]>
Co-authored-by: Evgeniy Tatarkin <[email protected]>
Co-authored-by: Chancellor Clark <[email protected]>
@bricemciver
Copy link

I think moving the docs broke "readthedocs"

@chanceaclark
Copy link
Contributor Author

chanceaclark commented Feb 28, 2020 •
edited
Loading

I think moving the docs broke "readthedocs"

@epicfaace is there a process in which you build docs? If so, would you mind building them?

I'll open up a new PR that I think might work, but feel free to close it if you just need to build the docs.

@chanceaclark chanceaclark mentioned this pull request Feb 28, 2020
Merged
7 tasks
epicfaace added a commit that referenced this pull request Feb 29, 2020
@epicfaace
Revert "chore: move docs to separate folder (#1604)"
05d241d 
This reverts commit b7ef383.
@epicfaace epicfaace mentioned this pull request Feb 29, 2020
Merged
epicfaace added a commit that referenced this pull request Feb 29, 2020
@epicfaace
Revert "chore: move docs to separate folder (#1604)" (#1618)
3b7433f 
This reverts commit b7ef383.
@epicfaace
Copy link
Member

Oops, my bad, should have tested to make sure it worked before merging it (maybe deploying the docs from that branch).

The docs get built automatically from master from readthedocs. I've just reverted this PR and that should fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@epicfaace epicfaace epicfaace approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@chanceaclark @epicfaace @bricemciver