docs for components sharing state

[acivitillo]

Adding documentation for components sharing state as discussed here: #561

I have added the 2 classic React examples: 1) synced input; 2) filterable list.

[rmorshea]

I'll take a look at this shortly. Thanks for the contribution!

[rmorshea]

Ultimately I think this content belongs under the "Managing State" section, but since it will probably be some time before I get around to writing more documentation, I'm going to accept this and move these docs around later. Thanks for writing this up!

[acivitillo]

thanks for the quick review! I will work on it in the weekend

[acivitillo]

OK I created the additional example for syncedinputs and moved the docs to managing-state

[rmorshea]

It looks like there's just a minor style issue. If you've got your dev environment set up you should be able to just run isort . to fix the issue.

Also, let me know if you experienced any issues contributing to IDOM while working on Windows. I have a Windows machine I can use to test things out myself so it's very possible there are gaps in the contributor guide.

[acivitillo]

ok I fixed the sorting of imports in the examples, it should work now

[acivitillo]

I run the nox -s test_docs. Sphinx passes but then I get a fail on docker it seems, I don't understand this part.

[acivitillo]

OK I had to fix 2 things to make this work and nox -s test_docs should now pass.

1. I had to upgrade npm in Dockerfile and fast-json-path in docs/source/_cusom_js/package-lock.json and in src/client/package-lock.json

2. I had to uncomment a 2nd Docker build in noxfile.py. nox is building the exact same docker image 2 times, from the looks of it the second build is not necessary and causes a bug (explained below)

Very interesting bug. The test_docs is building the same docker image 2 times, fix 1 above fixed the first build, but still the second build broke. The error is "Could not load /app/src/client/node_modules/fast-json-patch/index.mjs". This seems to happen because during the first docker build a folder node_modules is created inside the folder /client and for some reason this breaks the build. In fact, when I manually delete that folder it works.

[rmorshea]

I'm not quite sure what's going wrong here. Were you seeing problems with this locally or in CI? This may be a windows specific problem since I haven't observed any issues in CI.

[acivitillo]

I got the same error in local and in CI: Could not load /app/src/client/node_modules/fast-json-patch/index.mjs.

But take a look at line 124, there is another docker build in the noxfile.py, so nox is building the same docker image 2 times.

I think the first time docker build creates node_modules folder in client and for some reason, this breaks the second docker build.

[rmorshea]

take a look at line 124

That's a separate command for running the docs locally in a docker container during development. It shouldn't be getting run during CI. This command here is testing whether or not the container can be built in CI which should run successfully. If not, then the container probably won't build when we try to deploy it.

[rmorshea]

I'm gonna see what happens if I uncomment this. If it breaks in CI we can investigate.

[rmorshea]

Looks to be working now.

[acivitillo]

OK, then I will need to figure out how to run it locally w/o breaking. So the actual fix here was upgrading npm and fast-json-patch it seems.