diff --git a/admin/README.md b/admin/README.md index 8f06a6282e22..e12b4bea0af0 100644 --- a/admin/README.md +++ b/admin/README.md @@ -41,13 +41,6 @@ This folder contains tools or docs useful for project maintainers. to be added as part of a git commit, ensuring that they conform to the framework coding style standards, and automatically fixing what can be. -## Maintainer Scripts - -- **docbot** re-builds the user guide from the RST source for it, - and optionally deploys it to the `gh-pages` branch of the main - repository (if the user running it has maintainer rights on that repo). - See the [writeup](./docbot.md). - ## Release Scripts The release process is detailed in [RELEASE.md](./RELEASE.md). These scripts diff --git a/admin/alldocs b/admin/alldocs deleted file mode 100755 index 12d0b410ff84..000000000000 --- a/admin/alldocs +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash - -# Rebuild and deploy all CodeIgniter4 docs -# - -. admin/docbot $1 -. admin/apibot $1 \ No newline at end of file diff --git a/admin/apibot b/admin/apibot deleted file mode 100755 index 08b451a04bbb..000000000000 --- a/admin/apibot +++ /dev/null @@ -1,42 +0,0 @@ -#!/bin/bash - -# Rebuild and deploy CodeIgniter4 under-development user guide -# -# This is a quick way to test user guide changes, and if they -# look good, to push them to the gh-pages branch of the -# development repository. -# -# This is not meant for updating the "stable" user guide. - -UPSTREAM=https://github.com/codeigniter4/api.git - -# Prepare the nested repo clone folder -rm -rf build/api* -mkdir -p build/api/docs - -# Get ready for git -cd build/api -git init -git remote add origin $UPSTREAM -git fetch -git checkout master -git reset --hard origin/master -rm -r docs/* - -# Make the new user guide -cd ../.. -phpdoc -cp -R api/build/* build/api/docs - -# All done? -if [ $# -lt 1 ]; then - exit 0 -fi - -# Optionally update the remote repo -if [ $1 = "deploy" ]; then - cd build/api - git add . - git commit -S -m "APIbot synching" - git push -f origin master -fi diff --git a/admin/apibot.md b/admin/apibot.md deleted file mode 100644 index ba63aaf269fa..000000000000 --- a/admin/apibot.md +++ /dev/null @@ -1,36 +0,0 @@ -# apibot - -Builds & deploys API docs. - -The in-progress CI4 API docs, warts & all, are rebuilt and -then copied to a nested -repository clone (`build/api`), with the result -optionally pushed to the `master` branch of the `api` repo. -That would then be publicly visible as the in-progress -version of the [API](https://codeigniter4.github.io/api/). - -## Requirements - -You must have phpDocumentor installed, with a `phpdoc` alias installed globally. - -## Audience - -This script is intended for use by framework maintainers, -i.e. someone with commit rights on the CI4 repository. - -You will be prompted for your github credentials and -GPG-signing key as appropriate. - -## Usage - -Inside a shell prompt, in the project root: - - `admin/apibot [deploy]` - -If "deploy" is not added, the script execution is considered -a trial run, and nothing is pushed to the repo. - -Whether or not deployed, the results are left inside -`build/api` (which is git ignored). - -Generate these and the userguide together with the 'alldocs' script. diff --git a/admin/docbot b/admin/docbot deleted file mode 100755 index c4dd8229c9ac..000000000000 --- a/admin/docbot +++ /dev/null @@ -1,42 +0,0 @@ -#!/bin/bash - -# Rebuild and deploy CodeIgniter4 under-development user guide -# -# This is a quick way to test user guide changes, and if they -# look good, to push them to the gh-pages branch of the -# development repository. -# -# This is not meant for updating the "stable" user guide. - -UPSTREAM=https://github.com/codeigniter4/CodeIgniter4.git - -# Prepare the nested repo clone folder -cd user_guide_src -rm -rf build/* -mkdir build/html - -# Get ready for git -cd build/html -git init -git remote add origin $UPSTREAM -git fetch -git checkout gh-pages -git reset --hard origin/gh-pages -rm -r * - -# Make the new user guide -cd ../.. -make html - -# All done? -if [ $# -lt 1 ]; then - exit 0 -fi - -# Optionally update the remote repo -if [ $1 = "deploy" ]; then - cd build/html - git add . - git commit -S -m "Docbot synching" - git push -f origin gh-pages -fi \ No newline at end of file diff --git a/admin/docbot.md b/admin/docbot.md deleted file mode 100644 index a3577b2e5d36..000000000000 --- a/admin/docbot.md +++ /dev/null @@ -1,39 +0,0 @@ -# docbot - -Builds & deploys user guide. - -The in-progress CI4 user guide, warts & all, is rebuilt in a nested -repository clone (`user_guide_src/build/html`), with the result -optionally pushed to the `gh-pages` branch of the repo. -That would then be publicly visible as the in-progress -version of the [User Guide](https://codeigniter4.github.io/CodeIgniter4/). - -## Requirements - -You must have python & sphinx installed. - -## Audience - -This script is intended for use by framework maintainers, -i.e. someone with commit rights on the CI4 repository. - -This script wraps the conventional user guide building, -i.e. `user_guide_src/make html`, with additional -steps. - -You will be prompted for your github credentials and -GPG-signing key as appropriate. - -## Usage - -Inside a shell prompt, in the project root: - - `admin/docbot [deploy]` - -If "deploy" is not added, the script execution is considered -a trial run, and nothing is pushed to the repo. - -Whether or not deployed, the results are left inside -user_guide_src/build (which is git ignored). - -Generate these and the API docs together with the 'alldocs' script. diff --git a/utils/check_permission_x.php b/utils/check_permission_x.php index 441a875adcbe..c6155ea23a8c 100644 --- a/utils/check_permission_x.php +++ b/utils/check_permission_x.php @@ -32,9 +32,6 @@ function findExecutableFiles(string $dir, array $excludeDirs = []): array static $execFileList = [ '.github/scripts/deploy-userguide', '.github/scripts/secure-git-push', - 'admin/apibot', - 'admin/alldocs', - 'admin/docbot', 'admin/starter/builds', 'user_guide_src/add-edit-this-page', ];