Skip to content

docs(install): split installation doc in multiple sections#361

Merged
jeffladiray merged 14 commits into
betafrom
docs/split-install
Jul 12, 2022
Merged

docs(install): split installation doc in multiple sections#361
jeffladiray merged 14 commits into
betafrom
docs/split-install

Conversation

@jeffladiray
Copy link
Copy Markdown
Contributor

@jeffladiray jeffladiray commented Jun 27, 2022

Definition of Done

General

  • Write an explicit title for the Pull Request, following Conventional Commits specification
  • Test manually the implemented changes
  • Validate the code quality (indentation, syntax, style, simplicity, readability)
  • Ensure that Types have been updated according to your changes (if needed)

Security

  • Consider the security impact of the changes made

I looked out a lot of other various documentations.

  • Quickstart now embed a real "quick start" example, using mountOnStandaloneServer & SQL datasource with an example database - just in case
  • Installation should contain more in-depth installation process
    • Split all application framework we support to dedicated pages
    • Add more details on how to add a datasource
    • Update troubleshooting section to handle simple issues (CORS, how to debug, etc)

@forest-bot
Copy link
Copy Markdown
Member

@jeffladiray jeffladiray marked this pull request as ready for review June 28, 2022 14:29
Comment thread docs/getting-started/install/README.md Outdated
Comment thread docs/getting-started/install/README.md Outdated
@jeffladiray jeffladiray requested a review from Scra3 July 6, 2022 07:08
Comment thread docs/datasources/README.md
Comment thread docs/datasources/multiple-datasources/README.md Outdated
Comment thread docs/datasources/multiple-datasources/README.md Outdated
Comment thread docs/datasources/multiple-datasources/naming-conflicts.md Outdated
Comment thread docs/datasources/multiple-datasources/naming-conflicts.md Outdated
Comment thread docs/datasources/multiple-datasources/relationships.md Outdated
Comment thread docs/datasources/multiple-datasources/relationships.md Outdated
Comment thread docs/datasources/multiple-datasources/relationships.md Outdated
@jeffladiray jeffladiray merged commit f33017f into beta Jul 12, 2022
@jeffladiray jeffladiray deleted the docs/split-install branch July 12, 2022 09:44
@forest-bot
Copy link
Copy Markdown
Member

🎉 This PR is included in version 1.0.0-beta.1 🎉

The release is available on npm package (@beta dist-tag)

Your semantic-release bot 📦🚀

@forest-bot
Copy link
Copy Markdown
Member

🎉 This PR is included in version 1.0.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@forest-bot
Copy link
Copy Markdown
Member

🎉 This PR is included in version 1.0.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@forest-bot
Copy link
Copy Markdown
Member

🎉 This PR is included in version 1.0.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants