diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..cd37c80f45 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing to Prisma Documentation + +We welcome all contributions to the Prisma docs! If you come across some documentation that you feel is missing or incorrect, please open an issue or submit a pull request. + +## I am not sure my changes are valid + +If you are not sure your changes are valid, then please open an issue and we will discuss it. Contributions from community members are welcome and will be considered for inclusion. + +## Creating an issue + +There are no hard and fast rules for creating an issues to the repository. We only ask that you outline your reasoning for creating the issue and try to provide as much detail as possible. Depending on the issue, this could mean explaining what machine you are working on (Is it a Mac? Are you on a Windows machine?), or including a code snippet that demonstrates the issue. + +## Creating a pull request (PR) + +We have a pull request template. The basic breakdown is as follows: + +- Describe the reason for the PR. A little context goes a long way in helping to quickly scan the PR +- Briefly describe what changes were made +- Link to any relevant issues diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 0c6c2c27be..6510da3841 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,175 @@ -# Website +# Prisma Documentation -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/prisma/docs/blob/main/CONTRIBUTING.md) [![Slack](https://img.shields.io/badge/chat-on%20slack-blue.svg?style=flat-square)](https://slack.prisma.io/) [![Vercel](https://vercelbadge.vercel.app/api/prisma/docs)](https://vercel.com/prisma/docs/deployments) -### Installation +This repository contains the [source code](./src) and the [content](./content) for the [Prisma documentation](https://www.prisma.io/docs). + +## Contributing to the docs + +New contributors are welcome! Read through the [contributing guide](CONTRIBUTING.md) to learn how you can contribute to the Prisma documentation. + +## Prerequisites for Apple M1 chip (macOS BigSur and later) + +1. Install [`homebrew`](https://brew.sh/). +2. Install [`libvips`](https://github.com/libvips/libvips) via homebrew. + + ``` + brew install libvips + ``` + +## Run the docs site locally + +1. Clone this repository. +2. On your computer, open a terminal window in the repository's directory. +3. Run the following commands: ``` -$ yarn +cd docs +npm install +npm run dev ``` -### Local Development +## Run functions locally + +Run a local build to run the functions using the following command: ``` -$ yarn start +vercel dev ``` -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +> Make sure you have the correct path to `POSTGRES_URL` in your local `.env` file to test the functions -### Build +To prettify or format the code, run: ``` -$ yarn build +npm run format ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. +Visit `http://localhost:8000` to view the app. + +## Configure + +Write MDX files in `content` folder. + +Open `config.ts` for available config options for `gatsby`, `header`, `footer` and `siteMetadata`. + +- `gatsby` config for global configuration like + + - `pathPrefix` - Gatsby Path Prefix + - `siteUrl` - The url of the deployed site + - `titlePrefix` - The prefix to title that is added to the SEO title of the page + - `titleSuffix` - The suffix to title that is added to the SEO title of the page + +- `header` config for site header configuration like + + - `secondLevelHeaderMenuItems` - The text and links for the buckets on the second level of header + - `search` - The API keys for search functionality -### Deployment +- `footer` config for site footer configuration like -Using SSH: + - `newsletter` - Newsletter text +- `homepage` config for various links and content in the homepage of https://www.prisma.io/docs + + - `SummaryLinkData` - Links and text in the Summary section of homepage + - `GeneralLinkData` - Links and text in the General section of homepage + - `GuideLinkData` - Links and text in the Guide section of homepage + - `ReferenceLinkData` - Links and text in the Reference section of homepage + - `MoreUsefulLinks` - Links and text in the More Useful section of homepage + +- `siteMetadata` config for website related configuration + + - `title` - Title of the website in main page + - `description` - Description of the website + - `keywords` - Keywords of the website for SEO + +- `feedback` config for feedback urls + + - `sentimentUrl` - api path for sentiment details on feedback functionality + - `feedbackUrl` - api path for feedback details on feedback functionality + +## Inserting, moving and deleting files + +All files/folders in the context are prefixed with a _position_ which indicates the order in which they appear in the sidenav on the docs website. This makes it cumbersome to insert, move and delete files because the positions of a number of other files (if not all) in the same folder might need to be adjusted. Thanks to [Luca Steeb](https://github.com/steebchen/), you can perform these operations with a dedicated CLI called [`mdtool`](https://gist.githubusercontent.com/steebchen/bd085ebde1fcf4242e3fdd0df4d202a6/raw/c04e3d262eb6a302a9fab98f6428fec9329681e2/mdtool). + +### Install + +First, install `wget`: + +```bash +brew install wget ``` -$ USE_SSH=true yarn deploy + +Then use `wget` to install `mdtool`: + +```bash +wget https://gist.githubusercontent.com/steebchen/bd085ebde1fcf4242e3fdd0df4d202a6/raw/c04e3d262eb6a302a9fab98f6428fec9329681e2/mdtool -qO /usr/local/bin/mdtool +chmod +x /usr/local/bin/mdtool ``` -Not using SSH: +### Usage + +#### Overview ``` -$ GIT_USER= yarn deploy +mdtool insert 3 +mdtool swap A B +mdtool move A B +mdtool remove 4 ``` -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +#### `mdtool insert` + +Make place for a new file at given index and increment all numbers by one after that index: + +``` +$ mdtool insert INDEX + +# e.g.: +$ mdtool insert 2 + +# Result: for files 01-a, 02-b, 03-c, and 04-d; 03-c is renamed to 04-c and 04-d is renamed to 05-d so you can create a new file at index 2 +``` + +#### `mdtool swap` + +Swap two files; specify both filenames (prefix numbers get automatically adjusted): + +``` +$ mdtool swap FILENAME1 FILENAME2 + +# e.g.: +$ mdtool swap 03-file1.mdx 07-file2.mdx + +# Result: Files are now named: 03-file2.mdx 07-file1.mdx +``` + +#### `mdtool move` + +Move a given file to another given index + +``` +$ mdtool move FILENAME INDEX + +# e.g.: +$ mdtool move 05-file.mdx 2 + +# Result: 05-file.mdx is move to 02-file.mdx, plus previous files 02-*, 03-*, 04-* are incremented +``` + +#### `mdtool remove` + +Shift all other items by -1 at a given index: + +``` +$ mdtool remove INDEX + +# e.g.: +$ mdtool remove 2 + +# Result: 01-a, 02-b, 03-c, 04-d becomes 01-a, 02-b, 02-c, 03-d; 02-b is supposed to be manually deleted +``` + +#### Thanks Luca + +![](https://res.cloudinary.com/prismaio/image/upload/v1628765536/docs/LJ0FGHk_u2jjxv.png) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000000..5d93b0ad8d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +# Security Policy + +If you have a security issue to report, please contact us at [security@prisma.io](mailto:security@prisma.io). diff --git a/cSpell.json b/cSpell.json index fc82d6459f..a414d24793 100644 --- a/cSpell.json +++ b/cSpell.json @@ -149,4 +149,4 @@ "HTML Tags" ], "ignorePaths": [] -} \ No newline at end of file +}