Skip to content

Docs: faster onboarding, identify running processes, improve internal proxy clarification #3010

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.

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

Merged
merged 8 commits into from
Feb 1, 2022

Conversation

fredvd
Copy link
Member

@fredvd fredvd commented Jan 27, 2022

No description provided.

* They slow down readers who want to evaluate Volto as it is not relevant to them at that point in the TOC.
* Also these chapters need to be updated.
* Mentionning Quanta that is not finished at the beginning of the docs is  red flag to readers evaluating Voto for production use.
…s too small now.

First attempt to better describe in getting started why we only set up a javascript development environemtn by listing the running processes.
Use the same principle in the internal proxy documentation, list the processes, add the default value for the frontend API PATH, and describe the default request flow that prevents CORS issues.
@tiberiuichim tiberiuichim self-requested a review January 28, 2022 07:47
Copy link
Member

@sneridagh sneridagh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after fixing issues! Thanks for taking care!

@sneridagh
Copy link
Member

uh, I now see the merging issues. That's why I saw differences with the master ones.

Remove part of apiPATH, but disabling proxy through the config object still needs to be fixed.
@fredvd
Copy link
Member Author

fredvd commented Jan 31, 2022

Fixed the merge conflict this weekend, enough small text tinkering for now. Quick review and then merge? I see another PR/mentionning of the grander docs integration as well coming up.

@sneridagh
Copy link
Member

@fredvd watch out, we are about to merge #3001 !

@fredvd
Copy link
Member Author

fredvd commented Feb 1, 2022

@sneridagh I'm not merging my own PR's. But this one is ready.

@sneridagh
Copy link
Member

@fredvd ok, let's do this, since the merge looks good, let's merge this one. Then #3001

/cc @stevepiercy

@sneridagh sneridagh mentioned this pull request Feb 1, 2022
@stevepiercy
Copy link
Collaborator

This looks good to me.

#3001 has more work ahead and is not ready for release, unless you don't care about docs that will not automatically build and deploy to production.

There will need to be some merging, cherry-picking, or rebasing, no matter what. I'd suggest having two deployments in parallel, and port doc changes from master to plone6-docs. Please let me know.

@sneridagh sneridagh merged commit 5b50727 into master Feb 1, 2022
@sneridagh sneridagh deleted the doc_update_internal_proxy branch February 1, 2022 13:56
sneridagh added a commit that referenced this pull request Feb 2, 2022
* master: (25 commits)
  Add projectId for Cypress dashboard (#3023)
  Docs: faster onboarding, identify running processes, improve internal proxy clarification (#3010)
  Pin pyOpenSSL to 21.1.0
  Back to development
  Release 14.7.0
  Prepare for release
  Fix changelog
  Look ma, no `momentjs`! (#2910)
  Back to development
  Release 14.6.0
  Prepare for release
  Fix ObjectWidget story (#3009)
  Use `volto.config.js` as dynamic configuration for addons. It adds up… (#3008)
  fix: enable url with 'underscore' char
  fix: fixed italian translations
  Back to development
  Release 14.5.0
  Prepare for release
  Chenges to lockfile not saved, apparently :/
  Fix `language-independent-field` CSS class styling (#3005)
  ...
sneridagh added a commit that referenced this pull request Feb 2, 2022
* master: (25 commits)
  Add projectId for Cypress dashboard (#3023)
  Docs: faster onboarding, identify running processes, improve internal proxy clarification (#3010)
  Pin pyOpenSSL to 21.1.0
  Back to development
  Release 14.7.0
  Prepare for release
  Fix changelog
  Look ma, no `momentjs`! (#2910)
  Back to development
  Release 14.6.0
  Prepare for release
  Fix ObjectWidget story (#3009)
  Use `volto.config.js` as dynamic configuration for addons. It adds up… (#3008)
  fix: enable url with 'underscore' char
  fix: fixed italian translations
  Back to development
  Release 14.5.0
  Prepare for release
  Chenges to lockfile not saved, apparently :/
  Fix `language-independent-field` CSS class styling (#3005)
  ...
sneridagh added a commit that referenced this pull request Feb 2, 2022
* master: (25 commits)
  Add projectId for Cypress dashboard (#3023)
  Docs: faster onboarding, identify running processes, improve internal proxy clarification (#3010)
  Pin pyOpenSSL to 21.1.0
  Back to development
  Release 14.7.0
  Prepare for release
  Fix changelog
  Look ma, no `momentjs`! (#2910)
  Back to development
  Release 14.6.0
  Prepare for release
  Fix ObjectWidget story (#3009)
  Use `volto.config.js` as dynamic configuration for addons. It adds up… (#3008)
  fix: enable url with 'underscore' char
  fix: fixed italian translations
  Back to development
  Release 14.5.0
  Prepare for release
  Chenges to lockfile not saved, apparently :/
  Fix `language-independent-field` CSS class styling (#3005)
  ...
sneridagh added a commit that referenced this pull request Feb 2, 2022
* plone6-docs: (25 commits)
  Add projectId for Cypress dashboard (#3023)
  Docs: faster onboarding, identify running processes, improve internal proxy clarification (#3010)
  Pin pyOpenSSL to 21.1.0
  Back to development
  Release 14.7.0
  Prepare for release
  Fix changelog
  Look ma, no `momentjs`! (#2910)
  Back to development
  Release 14.6.0
  Prepare for release
  Fix ObjectWidget story (#3009)
  Use `volto.config.js` as dynamic configuration for addons. It adds up… (#3008)
  fix: enable url with 'underscore' char
  fix: fixed italian translations
  Back to development
  Release 14.5.0
  Prepare for release
  Chenges to lockfile not saved, apparently :/
  Fix `language-independent-field` CSS class styling (#3005)
  ...
sneridagh added a commit that referenced this pull request Feb 2, 2022
* master: (60 commits)
  Fix the a11y violation of UrlWidget (#2944)
  Back to development
  Release 14.7.1
  Prepare for release
  Add CSS body class in Babel view. Improve marker for language independent fields in Babel view too. (#3027)
  Add projectId for Cypress dashboard (#3023)
  Docs: faster onboarding, identify running processes, improve internal proxy clarification (#3010)
  Pin pyOpenSSL to 21.1.0
  Back to development
  Release 14.7.0
  Prepare for release
  Fix changelog
  Look ma, no `momentjs`! (#2910)
  Back to development
  Release 14.6.0
  Prepare for release
  Fix ObjectWidget story (#3009)
  Use `volto.config.js` as dynamic configuration for addons. It adds up… (#3008)
  fix: enable url with 'underscore' char
  fix: fixed italian translations
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants