Skip to content

Commit e9149be

Browse files
committed
finish docs
1 parent 96a2ab6 commit e9149be

3 files changed

Lines changed: 21 additions & 2 deletions

File tree

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ clean: ## Clean the temporary files.
1515
rm -rf .ruff_cache
1616
rm -rf megalinter-reports
1717
rm -rf debug.log
18+
rm -rf site
1819

1920
.PHONY: format
2021
format: ## Format the code.

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ All repositories within ONSdigital should be maintained to have an up-to-date `C
3535

3636
We encourage repository owners to archive their own repositories if they are no longer actively maintained or relevant. You can do this by going to the repository settings and selecting the "Archive" option. We recommend that you also add a notice to the repository's README file to inform users that the repository is archived and no longer maintained, along with closing any open issues or pull requests. This helps us align with GitHub's recommended practices for archiving repositories.
3737

38-
# Further Questions
38+
## Further Questions
3939

4040
For any further questions or concerns regarding the archiving process, please create an issue in the [Archive Tool repository](https://github.com/ONS-Innovation/github-repository-archive-script/issues) or contact an ONSdigital Owner.

docs/technical_documentation/the_process.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,25 @@ 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+
#### a. Last Updated
16+
17+
Has the repository been updated in the last year? If not, it is considered inactive and is eligible for archiving.
18+
19+
(The time period can be configured in the [Configuration](./configuration.md) file.)
20+
21+
Checking for updates allows the exemption mechanism to work. If an exemption file gets added or updated within the repository, it will have been updated and considered active.
22+
23+
#### b. Open Issues
24+
25+
If the repository is eligible for archiving, check if there is an open issue with the notification label.
26+
27+
If there is no such issue, create one to notify the team that the repository is being archived.
28+
29+
#### c. Archive Repository
30+
31+
If there is an open issue with the notification label, check how long the issue has been open.
32+
33+
If the issue has been open for more than 30 days (configurable in the [Configuration](./configuration.md) file), archive the repository.
1634

1735
## Process Flow Chart
1836

0 commit comments

Comments
 (0)