Backport 15-alpha docs #3066
Merged
Backport 15-alpha docs #3066
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a link to widget developer recipe at the end of Widget section. I think it is import to point developer where to find information about customizing and overriding widgets. Thanks @tiberiuichim for the tip https://community.plone.org/t/using-react-currency-selector/14737
stevepiercy
approved these changes
Feb 13, 2022
nileshgulia1
approved these changes
Feb 14, 2022
uh ok, I assumed that CHANGELOG would be done in the big merge, ok I will take care too. |
|
✔️ Deploy Preview for volto ready! 🔨 Explore the source changes: 71cfcd5 🔍 Inspect the deploy log: https://app.netlify.com/sites/volto/deploys/62122af5d0d3320008902e35 😎 Browse the preview: https://deploy-preview-3066--volto.netlify.app |
|
I updated the changelog but of course, there are some conflicts to solve. I guess it's better to merge this the last one. |
Merged
|
@sneridagh I just resolved the merge conflict in the changelog. Let's wait for the docs build to pass, then it is ready to merge. I'm not sure whether you want to merge this into |
|
Docs build passed! 🚀 |
|
@stevepiercy what's your concern, a new conflict in plone6-docs? |
|
we could certainly merge plone6-docs, then deal with conflicts when merging this on master. |
stevepiercy
approved these changes
Feb 20, 2022
|
I have no concern. I assumed you might have a preference. It's totally up to you. |
|
Let's merge this with plone6-docs then |
sneridagh
added a commit
that referenced
this pull request
Feb 20, 2022
* WIP on making something usable for sphinx * Add index files, to be used with spinx * Change cheatsheet to MyST, improve the main index * Make links into a bulleted list * Add MyST link examples and a seealso to documentation's MyST cheat sheet * First draft of contributing with Volto submodules. Move existing "Managing contributions on GitHub" section after "Contributor Roles" section * remove polluted .md files having which are not in docs/ * Fix all broken links and redirects, except: - volto/upgrade-guide/index.md:283: [broken] https://github.com/kitconcept/plone.volto/pull/29: 404 Client Error: Not Found for url: https://github.com/kitconcept/plone.volto/pull/29 - volto/addons/i18n.md:15: [broken] https://github.com/plone/volto/blob/master/src/i18n.js: 404 Client Error: Not Found for url: https://github.com/plone/volto/blob/master/src/i18n.js * Add change log entry * Fix one of two broken links * Move /recipes/overridei18n.md content to /recipes/i18n.md * Docs: Add metadata * Update add-on Internationalization to current way to do * Update CHANGELOG.md * grammar and syntax fixes Co-authored-by: Steve Piercy <web@stevepiercy.com> * grammar and syntax fixes Co-authored-by: Steve Piercy <web@stevepiercy.com> * grammar and syntax fixes Co-authored-by: Steve Piercy <web@stevepiercy.com> * mark technical terms Co-authored-by: Steve Piercy <web@stevepiercy.com> * Better wording Co-authored-by: Steve Piercy <web@stevepiercy.com> * Clear instructions and result Co-authored-by: Steve Piercy <web@stevepiercy.com> * grammar and syntax fixes Co-authored-by: Steve Piercy <web@stevepiercy.com> * Clear instructions and result Co-authored-by: Steve Piercy <web@stevepiercy.com> * MySt adjustments Co-Authored-By: Steve Piercy <web@stevepiercy.com> * Update i18n.md Line break * Create a new Documentation section in CHANGELOG.md * Final clean up - Consistent indent of enumerated list - Remove duplicate lines because GitHub does not allow multi-line suggestions * Deduplicate index label * Add line break * Remove bad merge conflict resolution * Fix typo * Content was moved to recipes/i18n.md * Fix bad link * Add MyST and Sphinx basic configuration * Add CHANGELOG.md entry * Add docs/_build/ to .gitignore * Remove references to files that were moved under developer-guidelines Remove comments that are obsolete Add html_meta values * Fix heading levels Add html_meta values * Align toctree elements with production Remove redundant directory listing Add html_meta values * Fix add-ons spelling Remove `./` Fix syntax highlighting and emphasis Fix broken references Add html_meta values * Fix jsx syntax highlighting Add html_meta values * Fix jsx syntax highlighting Add html_meta values * Fix reference to addons/index Add html_meta values * Fix references Add html_meta values * Merge plone6index.md into index.md Adjust references * Fix nginx syntax highlighting (conf -> nginx) Add html_meta values * Improve shell syntax highlighting and formatting Minor grammar fixes Add html_meta values * Minor grammar fixes Remove unused lexer parameter Add html_meta values * Fix download link Add html_meta values * Fix syntax highlighting Add html_meta values * Fix reference to addons/index Add html_meta values * Fix broken link to storybook Add html_meta values * Fix json highlighting (do not use ellipses or comments) Fix reference to openobjectbrowser-handler-api-label Add html_meta values * Add change log entry * Unfix "fixes" for jsx syntax highlighting * Don't use `'` in lexed code blocks. Sheesh! * Don't use `'` in lexed code blocks. Sheesh! * dedupe cheatsheet as its already in Plone docs * Revert "dedupe cheatsheet as its already in Plone docs" This reverts commit baffc8b. * Add plone to Intersphinx configuration, and update link in cheatsheet.md * Add CHANGELOG.md entry * Get version from package.json * Remove legacy folder in docs * Add typescript to toctree * Remove mkdocs config (#3070) * Remove mkdocs configuration * Use correct filename in Makefile to install requirements for standalone docs * Add CHANGELOG.md entry * Restore logos * Remove mkdocs remainings, docs-clean cleans also legacy docs envs * Move logos up to root of directory, and adjust link in README.md * Improve help comment * Update docs GitHub workflow to use Sphinx/MyST only * Add netlify target for preview of Sphinx HTML docs build * Add CHANGELOG.md entry for Netlify * Add runtime.txt to specify Python version for Netlify * Adjust Netlify build path Co-authored-by: Victor Fernandez de Alba <sneridagh@gmail.com> * Fix docs not referenced in any doctree. Cleanup the ones not needed * Use `orphan` field list item to build the file, but exclude from toctree omissions errors and navigation. * Add html_meta values * Use correct internal link reference * Grammar and one sentence per line * Remove obsolete links to Python Markdown extensions, now that we use MyST * Remove unnecessary and undefined variable from docs-livehtml target * Add CHANGELOG.md entry * Remove runtime.txt and instead use global setting for netlify See https://docs.netlify.com/configure-builds/environment-variables/ * Attempt to turn off some checks, set environment variable to use Python 3.8 * Remove blank configuration values. It is not possible to disable these preview builds. See https://answers.netlify.com/t/disabling-header-rules-pages-changed-redirect-rules-mixed-content-reports/46323/2 * Use netlify.toml to set PYTHON_VERSION env var instead of obscured global setting * Use MyST admonition syntax * Fix indentation of list items so that code blocks and admonitions align are within their list items Add html_meta tags * Remove optional `true` for `:sorted:` * Add html_meta values * Add CHANGELOG.md * Backport 15-alpha docs (#3066) * Changes in docs (upgrade guide) until Volto 15a3 * Upgrade Guide i18n: Make clear what's project, what add-on. @ksuess (backport #3056) * Add Widget additional information link (#2999) Add a link to widget developer recipe at the end of Widget section. I think it is import to point developer where to find information about customizing and overriding widgets. Thanks @tiberiuichim for the tip https://community.plone.org/t/using-react-currency-selector/14737 * Backport RAZZLE_ environment variable docs Add html_meta tag values for SEO See https://github.com/plone/volto/pull/3067/files#diff-00609ed769cd40cf3bc3d6fcc4431b714cb37c73cedaaea18fe9fc4c1c589597 * Backport upgrade guide for #2992 (Lazy load draftJS) * Backport Richsettings docs of #2992 * Backport docs for #3067 (ADDONS var) * Update changelog to latest Co-authored-by: Arky <hitmanarky@gmail.com> Co-authored-by: Steve Piercy <web@stevepiercy.com> Co-authored-by: Victor Fernandez de Alba <sneridagh@gmail.com> Co-authored-by: Steve Piercy <web@stevepiercy.com> Co-authored-by: nileshgulia1 <nileshgulia@gmail.com> Co-authored-by: ksuess <k.suess@rohberg.ch> Co-authored-by: Arky <hitmanarky@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
More to come today (and maybe next week), I'll ping when it's ready.
For now, we are even (checked in git history).