Skip to content

Commit 06357d4

Browse files
committed
chore: copy files from codeigniter4/userguide
1 parent d8d5275 commit 06357d4

6 files changed

Lines changed: 84 additions & 30 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/bin/sh -e
2+
3+
# Deploys the User Guide to the production
4+
# website. Triggered by updates to the GitHub
5+
# repo's master branch.
6+
7+
REPO=/opt/userguide
8+
SITE=/home/public_html/userguides/userguide4
9+
10+
cd "$REPO"
11+
git switch master
12+
git pull
13+
14+
rm -rf "$SITE"
15+
cp -R "$REPO/docs" "$SITE"
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Deploys the User Guide to the production
2+
# website whenever master branch is updated
3+
name: Deploy Production
4+
5+
on:
6+
push:
7+
branches:
8+
- master
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: executing remote ssh commands using ssh key
16+
uses: appleboy/ssh-action@master
17+
with:
18+
host: ${{ secrets.HOST }}
19+
username: ${{ secrets.USERNAME }}
20+
key: ${{ secrets.KEY }}
21+
port: ${{ secrets.PORT }}
22+
script: /opt/userguide/.github/scripts/deploy

admin/userguide/.gitignore

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
*/config/development
2+
*/logs/log-*.php
3+
!*/logs/index.html
4+
*/cache/*
5+
!*/cache/index.html
6+
!*/cache/.htaccess
7+
8+
user_guide_src/build/*
9+
user_guide_src/cilexer/build/*
10+
user_guide_src/cilexer/dist/*
11+
user_guide_src/cilexer/pycilexer.egg-info/*
12+
13+
#codeigniter 3
14+
application/logs/*
15+
!application/logs/index.html
16+
!application/logs/.htaccess
17+
/vendor/

admin/userguide/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 CodeIgniter 4 web framework
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

admin/userguide/README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
11
# CodeIgniter 4 User Guide
22

3-
## What is CodeIgniter?
4-
5-
CodeIgniter is a PHP full-stack web framework that is light, fast, flexible and secure.
3+
CodeIgniter 4 is a PHP web framework that is light, fast, flexible, and secure.
64
More information can be found at the [official site](http://codeigniter.com).
75

8-
This repository holds a composer-installable pre-built user guide for the framework.
9-
It has been built from the
10-
[development repository](https://github.com/codeigniter4/CodeIgniter4).
11-
12-
More information about the plans for version 4 can be found in [the announcement](http://forum.codeigniter.com/thread-62615.html) on the forums.
13-
14-
## Installation & updates
6+
**This is a read-only repository used to publish the user guide for the current release.**
7+
It is built automatically as part of the framework release workflow, and pull
8+
requests are not accepted here.
159

16-
`composer require codeigniter4/userguide` will install a copy
17-
of the user guide inside your project, at
18-
`vendor/codeigniter4/userguide`. You can then `composer update` whenever
19-
there is a new release of the framework.
10+
Development is done in the [main repository](https://github.com/codeigniter4/codeigniter4).
11+
If you find problems with the user guide, please submit a correcting pull request there.
2012

13+
If you feel that features are missing or unclear, please comment on our
14+
[forum](https://forum.codeigniter.com/index.php),
15+
in the appropriate CodeIgniter4 subforum.

admin/userguide/composer.json

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)