Skip to content

Commit 96a2ab6

Browse files
committed
md linting
1 parent a930ad3 commit 96a2ab6

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/faq.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
- Each week, the archive tool will process each non-archived repository within ONSdigital.
66
- For each repository, it will:
7-
- Check if the repository hasn't been updated within the last year.
8-
- If it hasn't been updated, it will create an issue in the repository to notify the maintainers. The issue will include details about how to avoid the repository being archived and how to archive the repository manually.
9-
- If an issue already exists for the repository, it will check how long ago the issue was created.
10-
- If the issue was created more than 30 days ago, the tool will archive the repository.
7+
- Check if the repository hasn't been updated within the last year.
8+
- If it hasn't been updated, it will create an issue in the repository to notify the maintainers. The issue will include details about how to avoid the repository being archived and how to archive the repository manually.
9+
- If an issue already exists for the repository, it will check how long ago the issue was created.
10+
- If the issue was created more than 30 days ago, the tool will archive the repository.
1111

1212
In depth information on this process is available within the [Technical Documentation](./technical_documentation/the_process.md).
1313

@@ -23,11 +23,11 @@ When a repository is archived, it becomes read-only. This means that no further
2323

2424
## How Do I Unarchive a Repository?
2525

26-
In order to unarchive a repository, you need to have administrative access to the repository either being an organisation or repository owner. You can unarchive a repository by going to the repository settings and selecting the "Unarchive" option.
26+
In order to unarchive a repository, you need to have administrative access to the repository either being an organisation or repository owner. You can unarchive a repository by going to the repository settings and selecting the "Unarchive" option.
2727

2828
To avoid the repository from being archived again, ensure that you push an update to the repository. This will make it exempt from archiving for another year. You may also want to add an `ArchiveExemption.txt` or `ArchiveExemption.md` file to the root of the repository to indicate that it should not be archived in the future.
2929

30-
It is important to note that if a repository is without an owner or has no active admin users, an organisation admin will need to unarchive the repository.
30+
It is important to note that if a repository is without an owner or has no active admin users, an organisation admin will need to unarchive the repository.
3131

3232
All repositories within ONSdigital should be maintained to have an up-to-date `CODEOWNERS` file and repository admins to ensure that access is available for unarchiving when necessary. This is specified within ONS' GitHub Usage Policy and must be adhered to.
3333

docs/technical_documentation/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,4 @@ This configuration ensures that the tool uses the cloud configuration, does not
116116

117117
If `use_local_config` is set to `false`, the tool will fetch the configuration from the cloud S3 bucket. This file can be tuned to the needs of the Technical Advisory Group (TAG) and will rarely need to be changed.
118118

119-
**It is essential that `use_local_config` is set to `false` when deploying to AWS.**
119+
**It is essential that `use_local_config` is set to `false` when deploying to AWS.**

docs/technical_documentation/notification_issue.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
When a repository is eligible for archiving (i.e. it has not been updated in the last year), an issue is created in the repository to notify owners/maintainers. This issue serves as a reminder and provides information on how to archive the repository or make it exempt from the process if desired.
44

5-
All created issues are given an `Archive Notice` label to easily identify them.
5+
All created issues are given an `Archive Notice` label to easily identify them.
66

77
## Issue Contents
88

@@ -45,4 +45,4 @@ notification_issue_body_tuple = (
4545
)
4646
```
4747

48-
**Please Note:** The above code snippet is only an example and might not be the exact code in your `src/main.py`.
48+
**Please Note:** The above code snippet is only an example and might not be the exact code in your `src/main.py`.

docs/technical_documentation/the_process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This includes the repository's name, when it was last updated and the number of
1212

1313
Iterate through each repository and check the following:
1414

15-
TODO: Finish process write up
15+
TODO: Finish process write up
1616

1717
## Process Flow Chart
1818

0 commit comments

Comments
 (0)