Skip to content

Commit

Permalink
Remove phab migration documentation (#379)
Browse files Browse the repository at this point in the history
The other documentation is sufficiently up to date that the warning can be removed.
Rename the `.mdx` pages to `.md` to make GitHub render diffs again.
  • Loading branch information
silkeh authored Sep 20, 2023
1 parent de3cba0 commit dba7afd
Show file tree
Hide file tree
Showing 8 changed files with 5 additions and 124 deletions.
8 changes: 0 additions & 8 deletions docs/packaging/_markdown-migration-warning.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/packaging/creating-a-new-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,6 @@ Once the build completes, your directory should now include the following files:
```text
├── abi_used_libs
├── abi_used_symbols
├── Makefile
├── package.yml
├── pspec_x86_64.xml
└── tree-2.1.1-1-1-x86_64.eopkg
Expand Down
6 changes: 1 addition & 5 deletions docs/packaging/index.mdx → docs/packaging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,13 @@ summary: Steps for setting up a packaging environment and submitting packages
sidebar_position: 0
---

import MigrationWarning from './_markdown-migration-warning.md';

<MigrationWarning/>

# Packaging Overview

This is the overall workflow for creating or updating a package.

## Development Environment Preparation

1. [Prepare for Packaging](prepare-for-packaging.mdx)
1. [Prepare for Packaging](prepare-for-packaging.md)
2. Review the [requirements for the package.yml file](docs/packaging/package.yml.md).
3. Also review our [Packaging Practices](docs/packaging/packaging-practices.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ summary: Quick guide on getting your system set up for packaging on Solus
sidebar_position: 1
---

import MigrationWarning from './_markdown-migration-warning.md';

<MigrationWarning/>

# Prepare for Packaging

## Switch to the Unstable Repository
Expand Down
58 changes: 0 additions & 58 deletions docs/packaging/procedures/diff-to-pull-request.md

This file was deleted.

42 changes: 0 additions & 42 deletions docs/packaging/procedures/migrate-repos-to-github.md

This file was deleted.

3 changes: 1 addition & 2 deletions docs/packaging/submitting-a-pull-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,8 @@ At minimum, your pull request will include changes for the following files:
- `package.yml`
- `pspec_*.xml`

It will also include these files:
It may also include these files:

- `Makefile`
- `MAINTAINERS.md`

Double check the `package.yml` to make sure the builddeps are in the right order, and that it otherwise adheres to the [standards](package.yml.md) Solus has set.
Expand Down
7 changes: 3 additions & 4 deletions docs/packaging/your-first-package-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: An example of how to build a package that exists in the Solus repos for

# Your First Package Update

This page will guide you through the steps required to build your first package. This is really a test to make sure that your [build environment is set up correctly](docs/packaging/prepare-for-packaging.mdx). You will clone an existing package, build it, then install it, and finally remove it.
This page will guide you through the steps required to build your first package. This is really a test to make sure that your [build environment is set up correctly](docs/packaging/prepare-for-packaging.md). You will clone an existing package, build it, then install it, and finally remove it.

## Cloning and building `nano`

Expand Down Expand Up @@ -58,10 +58,9 @@ You will be prompted to enter your password by sudo, and the `solbuild` tool wil
If the build is successful, you will have a `nano` package file with a name like `nano-7.2-161-1-x86_64.eopkg`. Run the `ls` tool to check the exact name:

```bash
ls

$ ls
abi_used_libs files package.yml
abi_used_symbols Makefile nano-7.2-162-1-x86_64.eopkg pspec_x86_64.xml
abi_used_symbols nano-7.2-162-1-x86_64.eopkg pspec_x86_64.xml
```

Congratulations! You have successfully built your first package on Solus.
Expand Down

0 comments on commit dba7afd

Please sign in to comment.