From 4303ef02131713e8d6c68ec4585e0d1e0d576282 Mon Sep 17 00:00:00 2001 From: Anthony Dillon Date: Thu, 12 Jan 2017 11:31:08 +0000 Subject: [PATCH] Separate deprecation notices to there own pages --- .gitignore | 1 + deprecation-notices/dn1.md | 26 +++++++++++++++++++++++ deprecation-notices/dn2.md | 8 ++++++++ deprecation-notices/dn3.md | 8 ++++++++ deprecation-notices/index.md | 40 ++++++++---------------------------- 5 files changed, 51 insertions(+), 32 deletions(-) create mode 100644 .gitignore create mode 100644 deprecation-notices/dn1.md create mode 100644 deprecation-notices/dn2.md create mode 100644 deprecation-notices/dn3.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..378eac2 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build diff --git a/deprecation-notices/dn1.md b/deprecation-notices/dn1.md new file mode 100644 index 0000000..e628d74 --- /dev/null +++ b/deprecation-notices/dn1.md @@ -0,0 +1,26 @@ +--- +title: DN1 +--- +## DN1 + +**The `snap` keyword has been replaced by `prime`.** + +Snapcraft supports providing a list of files to include/exclude from two steps in the lifecycle: stage and prime. That's done with two keywords in the yaml, respectively: `stage` and `snap`. The `snap` keyword has now been deprecated and replaced with `prime`, corresponding to the actual lifecycle step to which it applies. All other functionality remains the same. Where you wrote: + +```yaml +# ... +parts: + foo: + plugin: nil + snap: [bar] +``` + +Now write: + +```yaml +# ... +parts: + foo: + plugin: nil + prime: [bar] +``` diff --git a/deprecation-notices/dn2.md b/deprecation-notices/dn2.md new file mode 100644 index 0000000..958a5e8 --- /dev/null +++ b/deprecation-notices/dn2.md @@ -0,0 +1,8 @@ +--- +title: DN2 +--- +## DN2 + +**`snapcraft.yaml` should be in `snap/` directory.** + +Snapcraft has begun using the `snap` directory as the container for the `snapcraft.yaml`, hooks, and plugins, and the entire directory is migrated into the final snap to enable rebuilds. This means that a standalone `snapcraft.yaml` in the root of the project has been deprecated. diff --git a/deprecation-notices/dn3.md b/deprecation-notices/dn3.md new file mode 100644 index 0000000..19ce345 --- /dev/null +++ b/deprecation-notices/dn3.md @@ -0,0 +1,8 @@ +--- +title: DN3 +--- +## DN3 + +**`.snapcraft.yaml` should be moved to `snap/snapcraft.yaml`.** + +Snapcraft has begun using the `snap` directory as the container for the `snapcraft.yaml`, hooks, and plugins, and the entire directory is migrated into the final snap to enable rebuilds. This means that a standalone, hidden `.snapcraft.yaml` in the root of the project has been deprecated. diff --git a/deprecation-notices/index.md b/deprecation-notices/index.md index 934d6c6..712ecdd 100644 --- a/deprecation-notices/index.md +++ b/deprecation-notices/index.md @@ -1,34 +1,10 @@ -This document contains a list of deprecation notices and recommendations. - -# DN1 -**The `snap` keyword has been replaced by `prime`.** - -Snapcraft supports providing a list of files to include/exclude from two steps in the lifecycle: stage and prime. That's done with two keywords in the yaml, respectively: `stage` and `snap`. The `snap` keyword has now been deprecated and replaced with `prime`, corresponding to the actual lifecycle step to which it applies. All other functionality remains the same. Where you wrote: - -```yaml -# ... -parts: - foo: - plugin: nil - snap: [bar] -``` - -Now write: +--- +title: Deprecation notices +--- +## Deprecation notices -```yaml -# ... -parts: - foo: - plugin: nil - prime: [bar] -``` - -# DN2 -**`snapcraft.yaml` should be in `snap/` directory.** - -Snapcraft has begun using the `snap` directory as the container for the `snapcraft.yaml`, hooks, and plugins, and the entire directory is migrated into the final snap to enable rebuilds. This means that a standalone `snapcraft.yaml` in the root of the project has been deprecated. - -# DN3 -**`.snapcraft.yaml` should be moved to `snap/snapcraft.yaml`.** +This document contains a list of deprecation notices and recommendations. -Snapcraft has begun using the `snap` directory as the container for the `snapcraft.yaml`, hooks, and plugins, and the entire directory is migrated into the final snap to enable rebuilds. This means that a standalone, hidden `.snapcraft.yaml` in the root of the project has been deprecated. +- [DN1](/deprecation-notices/dn1) -- The `snap` keyword has been replaced by `prime`. +- [DN2](/deprecation-notices/dn2) -- `snapcraft.yaml` should be in `snap/` directory. +- [DN3](/deprecation-notices/dn3) -- `.snapcraft.yaml` should be moved to `snap/snapcraft.yaml`.