Changed lots of docs (#306)

RDIL · TravisEz13 · commit b322e952c86b · 2019-11-04T10:27:42.000-08:00
diff --git a/MAINTAINERS b/MAINTAINERS
@@ -0,0 +1,82 @@
+# PowerShell-Docker maintainers file
+# Adapted from Moby's maintainers file
+#
+# This file describes the maintainer groups within the PowerShell/PowerShell-Docker project.
+#
+# It is structured to be consumable by both humans and programs.
+# To extract its contents programmatically, use any TOML-compliant
+# parser.
+#
+[Org]
+
+    [Org."Core maintainers"]
+
+    # The Core maintainers are the ghostbusters of the project: when there's a problem others
+    # can't solve, they show up and fix it with bizarre devices and weaponry.
+    # They have final say on technical implementation and coding style.
+    # They are ultimately responsible for quality in all its forms: usability polish,
+    # bugfixes, performance, stability, etc. When ownership  can cleanly be passed to
+    # a subsystem, they are responsible for doing so and holding the
+    # subsystem maintainers accountable. If ownership is unclear, they are the de facto owners.
+
+    people = [
+        "TravisEz13",
+        "anmenega"
+    ]
+
+    [Org.Curators]
+
+    # The curators help ensure that incoming issues and pull requests are properly triaged and
+    # that our various contribution and reviewing processes are respected. With their knowledge of
+    # the repository activity, they can also guide contributors to relevant material or
+    # discussions.
+    # They are never expected to merge. They can however:
+    # - close an issue or pull request when it's an exact duplicate
+    # - close an issue or pull request when it's inappropriate or off-topic
+    # - make initial reviews for issues such as syntax errors and basic issues in code/docs
+
+    people = [
+        "RDIL"
+    ]
+
+    [Org.Alumni]
+
+    # This list contains maintainers that are no longer active.
+    # It is thanks to these people that the project has become what it is today.
+    # Thank you!
+
+    people = [
+    ]
+
+[people]
+
+# A reference list of all people associated with the project.
+# All other sections should refer to people by their canonical key
+# in the people section.
+
+    # ADD YOURSELF HERE IN ALPHABETICAL ORDER (First name)
+
+    [people.adityapatwardhan]
+        Name = "Aditya Patwardhan"
+        Email = ""
+        GitHub = "adityapatwardhan"
+
+    [people.andrew]
+        Name = "Andrew Menagarishvili"
+        Email = ""
+        GitHub = "anmenaga"
+
+    [people.rdil]
+        Name = "Reece Dunham"
+        Email = "me@rdil.rocks"
+        GitHub = "RDIL"
+
+    [people.kiazhi]
+        Name = "Ryen Tang"
+        Email = "Ryen.Tang@outlook.sg"
+        GitHub = "kiazhi"
+
+    [people.travisez13]
+        Name = "Travis Plunk"
+        Email = "github@ez13.net"
+        GitHub = "TravisEz13"
diff --git a/assets/README.powershell.md b/assets/README.powershell.md
@@ -62,7 +62,7 @@ PowerShell is licensed under the [MIT license][].
 By requesting and using the Container OS image for Windows containers, you acknowledge, understand,
 and consent to the Supplemental License Terms available on Docker Hub:
 
-- [Window Server Core](https://store.docker.com/_/windowsservercore)
+- [Windows Server Core](https://store.docker.com/_/windowsservercore)
 - [Nano Server](https://store.docker.com/_/nanoserver)
 
 [Third-Party Software Notices and Information](https://github.com/PowerShell/PowerShell/blob/master/ThirdPartyNotices.txt)
diff --git a/docs/development.md b/docs/development.md
@@ -4,7 +4,7 @@
 
 ### Folder structure
 
-The top level folder with the docker files is `release`.
+The top level folder with the `Dockerfile`s is `release`.
 This should only have folders under it.
 The three folders are:
 
@@ -17,43 +17,17 @@ The name of the folder will be the name of the image in the build system, but do
 For example, the `stable` Ubuntu 16.04 image is in `release/stable/ubuntu16.04`.
 In this folder, there are 4 items:
 
-* `docker` - a folder containing the `Dockerfile` to build the image and any other files needed in the Docker build context
-* `meta.json` - This is required for Linux images.  It should contain the following:
-
-```json
-{
-    "IsLinux" : true,
-    "tagTemplates": [
-        "my-tag",
-        "my-other-tag"
-    ]
-}
-```
-
-Tags are a JSON array that describes the tags the image should have.
-
-Tags you can use:
-  * `#psversion#` is replaced by the version of PowerShell used to build the image.
-  * `#tag#` is replaced by all tags generated by the `getLatestTag.ps1` script.
-  * `#shorttag#` is replaced by short tags generated by the `getLatestTag.ps1` script.
-  * `#longtag#` is replaced by long tags generated by the `getLatestTag.ps1` script.
-
-Example
-
-```json
-"tagTemplates": [
-    "#psversion#-windowsservercore-#tag#",
-    "windowsservercore-#tag#"
-]
-```
-
+* `docker` - A folder containing the `Dockerfile` to build the image and any other files needed in the Docker build context.
+* `test-deps` (official images only) - Directory for a sub-image. See the [`test-deps` image purpose](./index.md#test-dep-images).
+* `dependabot` (optional) - in this directory you can put a dummy `Dockerfile` for [Dependabot](https://dependabot.com) to auto-bump the version. See [Dependabot](#dependabot).
+* `meta.json` - See [this section](#metadata-files) later.
 * `getLatestTag.ps1` - This script should use the `Get-DockerTags` command from `tools\getDockerTags` to get the tags that should be used as the tag in the `FROM` statement in the Dockerfile.
 
-### Dockerfile Standards
+### `Dockerfile` Standards
 
-The Dockerfile should follow certain standards:
+All `Dockerfile`s should follow certain standards:
 
-* The following comments should be applied at the beginning of the dockerfile to all images:
+* The following comments should be applied at the beginning of the `Dockerfile`:
 
   * Copyright notice
   * Software license
@@ -146,3 +120,60 @@ Here is a template for an image build job:
     communityStable: true
     continueonerror: false
 ```
+
+## Tags
+
+Tags are a JSON array that describes the tags the image should have.
+
+### Supported Tags
+
+Tags you can use:
+
+  * `#psversion#` is replaced by the version of PowerShell used to build the image.
+  * `#tag#` is replaced by all tags generated by the `getLatestTag.ps1` script.
+  * `#shorttag#` is replaced by short tags generated by the `getLatestTag.ps1` script.
+
+### Example
+
+```json
+"tagTemplates": [
+    "#psversion#-windowsservercore-#tag#",
+    "windowsservercore-#tag#"
+]
+```
+
+## Metadata Files
+
+This file *is **required*** for all containers. Here is the bare minimum:
+
+```json
+{
+    "IsLinux" : true
+}
+```
+
+You should also add [tags](#tags) as a field.
+
+## Dependabot
+
+This repository has [Dependabot](https://dependabot.com) enabled on it.
+
+The PRs opened for automatic base-image-version bumps will be closed, but the version will most likely get increased.
+
+### Adding to a new Image
+
+You will need to put a `Dockerfile` in the `dependabot` directory of your image, simply containing:
+
+```dockerfile
+FROM my-base-image:1.0.0
+```
+
+You will also need to add an entry in the `/.dependabot/config.yml` file. Here is a template for that:
+
+```yaml
+- package_manager: "docker"
+    directory: "/release/theChannelHere/theImageHere/dependabot"
+    update_schedule: "daily"
+```
+
+> **Do not use `latest` as the base**, as this makes the whole purpose invalid!
