Skip to content

Commit

Permalink
Separate deprecation notices to there own pages
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonydillon committed Jan 12, 2017
1 parent 2f34708 commit 4303ef0
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 32 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
build
26 changes: 26 additions & 0 deletions deprecation-notices/dn1.md
Original file line number Diff line number Diff line change
@@ -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]
```
8 changes: 8 additions & 0 deletions deprecation-notices/dn2.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 8 additions & 0 deletions deprecation-notices/dn3.md
Original file line number Diff line number Diff line change
@@ -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.
40 changes: 8 additions & 32 deletions deprecation-notices/index.md
Original file line number Diff line number Diff line change
@@ -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`.

0 comments on commit 4303ef0

Please sign in to comment.