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.

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

🚀 Production release: Strapi docs v4.4.4 #1224

Merged
merged 226 commits into from
Oct 19, 2022
Merged

🚀 Production release: Strapi docs v4.4.4 #1224

merged 226 commits into from
Oct 19, 2022

Conversation

pwizla
Copy link
Collaborator

@pwizla pwizla commented Oct 19, 2022

See milestone for details

pwizla and others added 30 commits April 12, 2022 09:35
* Added TypeScript project structure

* added links to JS files in TS project structure

* Added admin-panel TS config

* Added .ts file paths and TypeScript SQlite database config code snippet

* Add TS server config

* Add middlewares TS config

* Add functions TS config

* Add cron jobs TS config

* Add API TS config

* Add plugins TS config

* Add SSO TS examples

* Add AWS deploy. TS

* Add Azure TS examples

* Add Heroku TS

* Add Caddy TS examples

* Add DO AppPlatform TS

* Add DO droplets TS

* Add GA engine TS

* Add admin custom TS examples

* Add Error Handling TS examples

* Add policies TS examples

* add admin-panel ts config

* add ts config

* add ts config

* add TypeScript to FAQ

* Start dedicated TypeScript page

* Added links to file structure page

* added more project structure ts links

* add TypeScript to sidebar

* add version detail to FAQ

* Add content to TypeScript page

* add ts file path

* fix GitHub .ts code snippet & add Okta js snippet

* Project structure: Reword intro sentence + add link to TS doc

* Project structure: Rename tabs

* Simplify --quickstart callout

* Fix casing

* Rename h1 for TS intro doc

* Fix two → 2 + add link to project structure doc

* Comment out unfinished sections

* Update RBAC with TS

* Update functions config with TS

* Fix AWS TS

* Fix Azure TS

* fix capitalization

* fix lint

* Remove comment

* add ts config

* add ts config

* add ts config

* add ts config

* Restore beta logo

* Comment out yarn setup command

Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>
This reverts commit 8c525c9.

Testing as auto-deploy does not seem to work 🤷
* lint cleanup

* lint cleanup

* add ts config -controllers

* add ts config --middlewares *check file path*

* add ts config --models

* add ts config --routes

* add ts config --webhooks

* update controllers code example

* update ts config --routes

* remove comments

* ts config code fix --routes

* fix ts config code --services

* fix ts config code examples --routes
just like on stable docs
* update TypeScript dedicated page

* fix punctuation

* TypeScript plugin dev updates

* TypeScript plugin dev updates

* improved accessibility

* improved text and table

* added note

* fix grammar

* fixed grammar

* fixed small wording issues

* add span tags to project structure comments

* fixed misc issues

* updated file-structure --ts

* Update docs/developer-docs/latest/development/plugins-development.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/development/plugins-development.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/development/plugins-development.md

Co-authored-by: Pierre Wizla <[email protected]>

* updated TypeScript directories and files table

* Update plugin development page

* Update docs/developer-docs/latest/development/plugins-development.md

Co-authored-by: Pierre Wizla <[email protected]>

* add link to Strapi Market

Co-authored-by: Pierre Wizla <[email protected]>
* Media Library and folders documentation (WIP)  (#867)

* Added content

* Added content about plugins

* added png files for plugins

* added more logo png files

* fixed missing file extension

* Revised and added content

* Revised text and table cleanup

* Revised Gatsby preview plugin content

* Add Media library to sidebar

* Add draft of Media Library intro

* Add media library to navbar

* Add media library to TOC

* Switch order of upload asset & create folder

* Create 'adding asset' WIP skeleton

* Move list of supported file types to 'adding assets'

* Create 'folders' section skeleton

* Add "managing assets" to TOC

* Rework a bit "Adding assets"

* Add comments to intro to media lib.

* Add draft/todo for "organizing assets with folders"

* Add "managing assets" skeleton

* Reorganize files and draft structure

* Improve introduction, add sorting & filtering

* Update edit assets structure

* Describe adding folders

* Add note about deep folder hierarchy pitfalls

* Refine introduction

* Complete draft of "organizing assets with folders"

* Add various improvements after a first re-read

* Improve "adding assets"

* Improve "introduction to media library"

* Improve "organizing assets with folders"

* Fix image files

* Add draft for "editing and deleting assets"

* Improve draft on editing assets

* Delete superfluous word in folders description

* Improve further the editing assets section

* Add final draft for editing section

* Rename the "editing" section file

* Remove unnecessary heading cross-linking

* Add screenshot todos

* Rename (bis)

* Make some tiny wording improvements

* Convert alternative instructions for the folder deletion to a note

* Delete strapi-plugins.md

* Re-add original Strapi plugins file

* Replace "Right" w/ "Just"

* Remove some features from the screenshot

* Fix improper grammar: allow to → allow +ing

* Clean up some TODOs

* Move supported media types out of details block and back to "adding assets"

* Clean up one more TODO 😅

* Remove unnecessary link to ML + add link to CM

* Fix wording

* Fix icon name typo

* Move "deleting assets" at end of file

* Add TODO for sorting screenshot

* Fix node engine (should ease Vercel deploy.)

* Remove (again) supported types from intro

* Fix list

* Mention folder names are searchable

* Fix button name for moving assets

* Open folders by single-click

* Replace default location for new sub-folder creation by the active folder

* Fix 1st step of folder edition instructions

* Fix editing folder instructions in note callout

* Mention folders as well in sorting options in intro

* Fix again folder editing instructions 😅

* Fix singular/plural for managing assets intro

* drop-down → button

* Mention batch move

Co-authored-by: Maeva Lienard <[email protected]>

* Document Media Library settings

* Add link to Media Library from "Writing content" table

* Update screenshots and text accordingly

* Update wording: folder →  subfolder in deeply nested hierarchy tip.

Co-authored-by: Maeva Lienard <[email protected]>

* Rework the sort section (adding screenshot)

* Refine Media Library overview screenshot

* Add SEO tags and remove TODOs

Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: Maeva Lienard <[email protected]>

* TypeScript additions for release 4.3.0-beta (#935)

* add TypeScript typings

* add alt text

* add raw TS content and code blocks

* Add typings example and misc improvements

* update programmatic use text

* add programmatic examples + other fixes

* Update docs/developer-docs/latest/setup-deployment-guides/typescript.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/setup-deployment-guides/typescript.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/setup-deployment-guides/typescript.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/setup-deployment-guides/typescript.md

Co-authored-by: meganelacheny <[email protected]>

* Create dedicated TypeScript page in the Development section

* Improve TypeScript support page (#932)

* Remove TypeScript create section from TypeScript page

* remove Understand Typescript from TypeScript page

* create TypeScript config page

* Edit TypeScript config introduction

* Change title and add links for project, install and config

* Add typescript config page to sidebar

* fix spelling

* delete typings and programmatic content

* Update docs/developer-docs/latest/development/typescript.md

Co-authored-by: Pierre Wizla <[email protected]>

* update intro and add callout

* Change table column order

* add link

* Update docs/developer-docs/latest/development/typescript.md

Co-authored-by: meganelacheny <[email protected]>

* Move development back to development page

* update top matter

Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: meganelacheny <[email protected]>

* Improve TypeScript typings subsection (#930)

* Improve TypeScript typings subsection

* Fix grammar

Co-authored-by: Gabriel <[email protected]>

* Fix wording: interfaces → properties

Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* Fix snippet

Co-authored-by: Gabriel <[email protected]>
Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* Fix canonicalUrl SEO tag

* Improve wording

* Fix broken links

* Add "Start Strapi programmatically" subsection (#921)

Co-authored-by: Pierre Wizla <[email protected]>

Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: meganelacheny <[email protected]>
Co-authored-by: Gabriel <[email protected]>
Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* Delete autocomplete GIF

* Bump version number to 4.3.0-beta

* Remove mention to beta docs as we're already in there

* Add warning callout about downgrading and folders (#942)

Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: Maeva Lienard <[email protected]>
Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: meganelacheny <[email protected]>
Co-authored-by: Gabriel <[email protected]>
Co-authored-by: Jean-Sébastien Herbaux <[email protected]>
* add project structure link

* revise programmatic use

* Add table for directories and rework explanations

* Fix email documentation that prevented hot reload

* update code block

* Update mixed codebase example

* add note

* rework programmatic content

* rework combined JS + TS programmatic section

* a link for public directory docs

* rework programmatic section

* remove non-TypeScript examples

* remove utils

* fixed compile method

* revert directories code block

* remove content

* edit strapi.compile text and add code example back for this afternoon

* Streamline the content of programmatic sections

* reword `strapi.compile()` 1st sentence

* Update docs/developer-docs/latest/development/typescript.md

Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* Update docs/developer-docs/latest/development/typescript.md

Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* Update docs/developer-docs/latest/development/typescript.md

Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* Update docs/developer-docs/latest/development/typescript.md

Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* remove "install" from yarn install command

* fix yarn and npm commands

* add alternate text idea

* add generate typings

* update generate typings section

* update CLI commands for TS generate typings

* add schema typings callout to models documentation

* clean up writing

* Simplify cross-link wording

* Simplify cross-link wording

* Rename CLI command

* Improve CLI docs: Add flags and remove TypeScript-only note

* Improve rendering of CLI flags documentation

* Add link to CLI docs

* Fix typo + remove parenthesis

Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* Improve wording on CLI

Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: Jean-Sébastien Herbaux <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>

Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: Jean-Sébastien Herbaux <[email protected]>
stb13579 and others added 13 commits October 18, 2022 10:31
move unit testing to dev resources
add reasoning for skipping v4.3.7
Update migration-guide-4.3.6-to-4.3.7.md
* Update Dark Mode documentation for new syntax

* Fix caution note

* Improve wording

Co-authored-by: Gustav Hansen <[email protected]>

* Improve code example for Dark Mode

Co-authored-by: Gustav Hansen <[email protected]>

* Improve wording in config options table

Co-authored-by: Gustav Hansen <[email protected]>

* Improve caution callout

Co-authored-by: Gustav Hansen <[email protected]>
Signed-off-by: Derrick Mehaffy <[email protected]>

Signed-off-by: Derrick Mehaffy <[email protected]>
* update file name

* fix link and snippet
…methods (#1197)

* start working on additional error handlers

* Refactor error handling documentation to include @strapi/utils errors

Signed-off-by: Derrick Mehaffy <[email protected]>

* Fix typescript typo

Signed-off-by: Derrick Mehaffy <[email protected]>

* Add minor style updates for consistency

Signed-off-by: Derrick Mehaffy <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>
@vercel
Copy link

vercel bot commented Oct 19, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
documentation ✅ Ready (Inspect) Visit Preview Oct 19, 2022 at 0:21AM (UTC)

@pwizla pwizla self-assigned this Oct 19, 2022
@strapi-cla
Copy link

strapi-cla commented Oct 19, 2022

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
7 out of 8 committers have signed the CLA.

✅ StrapiShaun
✅ pwizla
✅ GunnerJnr
✅ meganelacheny
✅ gpene
✅ omerfaran
✅ derrickmehaffy
❌ mikehaertl
You have signed the CLA already but the status is still pending? Let us recheck it.

@pwizla pwizla added source: Dev Docs PRs/issues targeting the Developer Docs source: User Guide PRs/issues targeting the User Guide internal PRs created by the Strapi core team target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch). size: large If the PR includes 1+ file(s) with a total of 50+ lines of text or 100+ lines of code labels Oct 19, 2022
@pwizla pwizla added this to the 4.4.4 milestone Oct 19, 2022
* initial config update

* add table indexing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs created by the Strapi core team size: large If the PR includes 1+ file(s) with a total of 50+ lines of text or 100+ lines of code source: Dev Docs PRs/issues targeting the Developer Docs source: User Guide PRs/issues targeting the User Guide target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch).
Projects
None yet
Development

Successfully merging this pull request may close these issues.