Initial commit

Author: dgarcia360

.github/workflows/gh-pages.yml

@@ -0,0 +1,31 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+
+      - name: Install dependencies
+        run: npm install
+      - name: Build website
+        run: npm run build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./build

.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+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.

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/configuration/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Configuration",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Step-by-step configuration guides for customizing the preview generation."
+  }
+}

docs/configuration/authentication.mdx

@@ -0,0 +1,26 @@
+---
+sidebar_position: 1
+---
+
+import GitHubSecret from '../installation/_partials/github-secret.mdx';
+
+# Authentication
+
+PushPreview leverages an API key for secure and automated preview generation across your projects.
+This key, once generated, can be used accross multiple repositories, facilitating a unified preview deployment across various projects.
+
+## Generate the PushPreview API Key
+
+To obtain an API key, follow these steps:
+
+1. Log into your PushPreview account.
+
+1. Navigate to the **Teams** tab.
+
+1. Under the **API Keys** section, click on **Create API Key**. 
+
+1. The generated API key will be displayed for you to copy. Remember to save this key securely, as it will only be displayed once and cannot be retrieved later.
+
+## Integration with projects
+
+<GitHubSecret />

docs/configuration/private-previews.md

@@ -0,0 +1,37 @@
+---
+sidebar_position: 2
+---
+
+# Private previews
+
+Previews generated through PushPreview are public by default, allowing anyone with the link to access them. However, for added security or to maintain confidentiality, PushPreview provides an option to set these previews to be private. This ensures that only authorized viewers can see them, making it a crucial feature for sensitive or confidential projects.
+
+Private previews work by restricting access to users who have `READ` permissions over the repository linked to the preview.
+This means that only team members or collaborators with the necessary permissions can view the private previews.
+
+There are two ways to enable private previews: setting them as private by default for your entire team or marking individual integrations as private.
+
+## Enable private previews by default
+
+To make all previews private by default for all your integrations, follow these steps:
+
+1. Log in to your PushPreview account.
+1. Navigate to the **Team** page.
+1. Turn on the **Private previews** option.
+1. Save the changes.
+
+This setting ensures that every new preview generated will be private, accessible only to users with the appropriate permissions.
+
+## Mark individual integrations as private
+
+For more granular control, you can set privacy settings on a per-integration basis:
+
+1. Log into your PushPreview account.
+1. Navigate to the **Integrations** page.
+1. Choose the integration you want to modify.
+1. Click **Edit**.
+1. Enable the **Private previews** option.
+1. Save the changes.
+
+This option is ideal for teams that require different privacy levels for various integrations, allowing flexibility and control over who can access specific previews.
+

docs/images/pushpreview-demo.png

@@ -0,0 +1,8 @@
+{
+  "label": "Installation",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Step-by-step installation guides for a range of programming languages and frameworks."
+  }
+}

docs/installation/_category_.json

@@ -0,0 +1,19 @@
+---
+sidebar_label: Antora
+---
+
+# Pull request previews for Antora
+
+Here's a step-by-step guide to help you install PushPreview in your Antora project using NPM.
+
+## Prerequisites
+
+Before you begin, you'll need to have the following:
+
+- A PushPreview account. If you don't have one, [sign up for free](https://app.pushpreview.com/accounts/signup/).
+- An Antora site created.
+
+## Installation
+
+To integrate the PushPreview into your Antora site:
+