Merge pull request #460 from cweagans/docs-2

Add some docs
cweagans · Feb 10, 2023 · f9b1973 · f9b1973
2 parents 1248156 + 5c4de34
commit f9b1973
Show file tree

Hide file tree

Showing 30 changed files with 364 additions and 194 deletions.
diff --git a/docs/.htaccess b/docs/.htaccess
diff --git a/docs/_index.md b/docs/_index.md
@@ -4,29 +4,33 @@ description: A simple plugin for Composer that allows you to apply patches to yo
 layout: projecthome
 github: https://github.com/cweagans/composer-patches
 buttons:
- - title: "View on Github"
- href: https://github.com/cweagans/composer-patches
- style: blue
- - title: "Project updates"
- href: https://www.cweagans.net/projects/composer-patches
- style: blue
+
+- title: "View on Github"
+ href: https://github.com/cweagans/composer-patches
+ style: blue
+- title: "Project updates"
+ href: https://www.cweagans.net/projects/composer-patches
+ style: blue
+
 quicklinks:
- - title: "Getting started"
- icon: installation
- description: "Step-by-step guides to installing the plugin and basic usage."
- href: #
- - title: "Usage & Configuration"
- icon: plugins
- description: "Advanced usage information for users with complex workflows."
- href: #
- - title: "Development"
- icon: architecture
- description: "Interact with the plugin programmatically for specialized use-cases."
- href: #
- - title: "Contributing"
- icon: themes
- description: "Contribute to development and keep the project alive and healthy."
- href: #
+
+- title: "Installation"
+ icon: installation
+ description: "Get up-and-running with Composer Patches in your project"
+ href: /composer-patches/getting-started/installation
+- title: "Workflow"
+ icon: plugins
+ description: "Learn how to use Composer Patches with a group of engineers."
+ href: /composer-patches/usage/workflow
+- title: "Troubleshooting"
+ icon: architecture
+ description: "Figure out how to solve any problems that you run into."
+ href: /composer-patches/troubleshooting/guide
+- title: "Contributing"
+ icon: themes
+ description: "Contribute to development and keep the project alive and healthy."
+ href: /composer-patches/project/contributing
+
 ---
 
 {{< quicklinks >}}
@@ -36,5 +40,6 @@ All documentation for the current, produciton-ready version of the plugin is in
 {{< /warning >}}
 
 {{< warning title="This guide is still under construction" >}}
-All of the documentation for 1.x versions of the plugin was in the readme. For 2.x, I want a more developed set of documentation that gives people as much information as they need. I'm still writing here, so expect some rough edges.
+All of the documentation for 1.x versions of the plugin was in the readme. For 2.x, I want a more developed set of
+documentation that gives people as much information as they need. I'm still writing here, so expect some rough edges.
 {{< /warning >}}
diff --git a/docs/api/_index.md b/docs/api/_index.md
@@ -0,0 +1,4 @@
+---
+title: API
+weight: 40
+---
diff --git a/docs/api/capabilities.md b/docs/api/capabilities.md
@@ -0,0 +1,4 @@
+---
+title: Capabilities
+weight: 20
+---
diff --git a/docs/api/events.md b/docs/api/events.md
@@ -0,0 +1,4 @@
+---
+title: Events
+weight: 30
+---
diff --git a/docs/api/example-event-plugin.md b/docs/api/example-event-plugin.md
@@ -0,0 +1,4 @@
+---
+title: Writing an event subscriber
+weight: 70
+---
diff --git a/docs/api/example-resolver-plugin.md b/docs/api/example-resolver-plugin.md
@@ -0,0 +1,4 @@
+---
+title: Writing a resolver plugin
+weight: 60
+---
diff --git a/docs/api/overview.md b/docs/api/overview.md
@@ -0,0 +1,4 @@
+---
+title: Overview
+weight: 10
+---
diff --git a/docs/api/patches-lock.md b/docs/api/patches-lock.md
@@ -0,0 +1,4 @@
+---
+title: Patches.lock
+weight: 40
+---
diff --git a/docs/getting-started/_index.md b/docs/getting-started/_index.md
@@ -0,0 +1,4 @@
+---
+title: Getting Started
+weight: 10
+---
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
@@ -0,0 +1,14 @@
+---
+title: Installation
+weight: 20
+---
+
+Installation is the same as any other Composer package:
+
+```shell
+composer require cweagans/composer-patches:~2.0
+```
+
+{{< warning title="2.0.0 is not released yet" >}}
+This documentation is being written in advance of the release of 2.0.0. The above command will not work yet.
+{{< /warning >}}
diff --git a/docs/getting-started/system-requirements.md b/docs/getting-started/system-requirements.md
@@ -0,0 +1,29 @@
+---
+title: System Requirements
+weight: 10
+---
+
+Supporting every version of the software that we depend on is not feasible, so we support a limited, "modern-ish" system
+configuration.
+
+## PHP
+
+We follow the list of [currently supported PHP versions](https://www.php.net/supported-versions.php) provided by the
+community. Unsupported/EOL versions of PHP will not be supported under any circumstances.
+
+## Composer
+
+Composer 2.2 (LTS) is the minimum version. However, few people run such an old version of Composer and we do not
+regularly test functionality with anything other than the current stable release. If you run into problems, we _will_
+ask you to try a recent version of Composer before proceeding with troubleshooting.
+
+## Patchers
+
+Most of the patchers that are supported don't change much, but there are a couple version-related items to keep in mind:
+
+* **General**: If you're using a particular program for applying patches, it would be great if it was a version that was
+ released in the last few years. As a rule of thumb, if the version of whatever software is older than what is
+ distributed with the current Debian "stable" release, we probably won't be able to do much with it.
+* **GNU Patch**: Version 2.7 added support for most features of the `diff --git` format and is required for any patches
+ that rename/copy files, change permissions, or include symlinks. Future versions of Composer Patches may consider
+ lesser versions to be unusable.
diff --git a/docs/getting-started/terminology.md b/docs/getting-started/terminology.md
@@ -0,0 +1,4 @@
+---
+title: Terminology
+weight: 30
+---
diff --git a/docs/introduction/_index.md b/docs/introduction/_index.md
diff --git a/docs/introduction/getting-started.md b/docs/introduction/getting-started.md
diff --git a/docs/introduction/installation.md b/docs/introduction/installation.md
diff --git a/docs/project/_index.md b/docs/project/_index.md
@@ -0,0 +1,4 @@
+---
+title: Project
+weight: 50
+---
diff --git a/docs/project/code-of-conduct.md b/docs/project/code-of-conduct.md
@@ -0,0 +1,4 @@
+---
+title: Code of conduct
+weight: 30
+---
diff --git a/docs/project/contributing.md b/docs/project/contributing.md
@@ -0,0 +1,4 @@
+---
+title: Contributing
+weight: 10
+---
diff --git a/docs/project/security.md b/docs/project/security.md
@@ -0,0 +1,4 @@
+---
+title: Security
+weight: 40
+---
diff --git a/docs/project/support-policy.md b/docs/project/support-policy.md
@@ -0,0 +1,4 @@
+---
+title: Support policy
+weight: 20
+---
diff --git a/docs/troubleshooting/_index.md b/docs/troubleshooting/_index.md
@@ -0,0 +1,4 @@
+---
+title: Troubleshooting
+weight: 30
+---
diff --git a/docs/troubleshooting/fixing-your-patch.md b/docs/troubleshooting/fixing-your-patch.md
@@ -0,0 +1,4 @@
+---
+title: Fixing your patch
+weight: 30
+---
diff --git a/docs/troubleshooting/guide.md b/docs/troubleshooting/guide.md
@@ -0,0 +1,4 @@
+---
+title: Guide
+weight: 10
+---
diff --git a/docs/troubleshooting/non-patchable-targets.md b/docs/troubleshooting/non-patchable-targets.md
@@ -0,0 +1,4 @@
+---
+title: Non-patchable targets
+weight: 20
+---
diff --git a/docs/usage/_index.md b/docs/usage/_index.md
@@ -0,0 +1,4 @@
+---
+title: Usage
+weight: 20
+---
diff --git a/docs/usage/commands.md b/docs/usage/commands.md
@@ -0,0 +1,4 @@
+---
+title: Commands
+weight: 40
+---