diff --git a/.gitignore b/.gitignore index 93432208..5d121559 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,6 @@ ehthumbs.db Icon? Thumbs.db *.swp -.vscode # Custom _meta diff --git a/.lando.dist.sh b/.lando.dist.sh deleted file mode 100644 index 8bafbd98..00000000 --- a/.lando.dist.sh +++ /dev/null @@ -1,24 +0,0 @@ -# grav installer for Lando -gravVersion="1.7.12" -cd ~/ -# check for existing grav -echo "Checking Grav" -if [[ $(< grav.txt) == "$gravVersion" ]]; then - # valid grav version - echo "Grav $gravVersion installed, no further action required" - exit -else - echo "Installing Grav $gravVersion" - # cleanup existing install if present - find -path "./grav/*" -not -path "./grav" -not -path "./grav/user/*" -not -path "./grav/user" -delete - # need to install grav - wget -q https://getgrav.org/download/core/grav/$gravVersion - unzip -q $gravVersion -x "grav/user/*" - rm $gravVersion - cd grav - # run install command - bin/grav install - # mark as installed - cd .. - echo $gravVersion > grav.txt -fi \ No newline at end of file diff --git a/.lando.dist.yml b/.lando.dist.yml deleted file mode 100644 index 3d7bf6bb..00000000 --- a/.lando.dist.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: userfrosting-learn - -services: - appserver: - type: php:7.4 - via: apache:2.4 - ssl: true - webroot: ../var/www/grav - app_mount: false - overrides: - volumes: - - ./:/var/www/grav/user - - ./setup.php:/var/www/grav/setup.php - -events: - pre-start: - - appserver: bash ~/grav/user/.lando.dist.sh - -proxy: - appserver: - - learn.userfrosting.lndo.site - diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..10873e9c --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,7 @@ +{ + "recommendations": [ + "streetsidesoftware.code-spell-checker", + "bierner.markdown-preview-github-styles", + "fcrespo82.markdown-table-formatter" + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..f45955c5 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,18 @@ +{ + "cSpell.diagnosticLevel": "Information", + "cSpell.words": [ + "autowire", + "Birke", + "charette", + "Grav", + "Laravel", + "Mele", + "middlewares", + "phpstan", + "Phpunit", + "Rememberme", + "Sprunje", + "UserFrosting", + "weissman" + ], +} \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 00000000..6a81de51 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,40 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Docker Build", + "type": "shell", + "command": "docker build -t learn:latest .", + "problemMatcher": [], + "group": "build" + }, + { + "label": "Launch Docker", + "type": "shell", + "command": "docker run -d --rm --name=learn -p 8888:80 -v \"$(pwd):/var/www/grav/user\" learn:latest", + "problemMatcher": [], + "group": "build" + }, + { + "label": "Launch Docker (No Destroy)", + "type": "shell", + "command": "docker run -d --name=learn -p 8080:80 -v \"$(pwd):/var/www/grav/user\" learn:latest", + "problemMatcher": [], + "group": "build" + }, + { + "label": "Stop Docker", + "type": "shell", + "command": "docker stop learn", + "problemMatcher": [], + "group": "build" + }, + { + "label": "Access Docker", + "type": "shell", + "command": "docker exec -it learn bash", + "problemMatcher": [], + "group": "build" + } + ] +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe0bc679..f2178d40 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,15 +19,8 @@ UserFrosting documentation is written in Markdown. Usual Markdown syntax is avai ## Pull Requests -Pull Requests for this repository should be created against the appropriate branch as per the table below. If you're unsure, just pick the branch that fits best and someone will take it from there. - -| Change should be published | Branch to make PR against | -|---|---| -| current release | `master` | -| next patch release | `hotfix` | -| next breaking change release | `develop` | -| previous release | `previous.vesion.branch` | +Each minor version of UserFrosting has a corresponding branch on this repository. Pull Requests for this repository should be created against the appropriate branch/version. If you're unsure, just pick the main branch. ## Code contributions -Please direct your attention to the [UserFrosting contribution guide](https://github.com/userfrosting/UserFrosting/blob/master/.github/CONTRIBUTING.md) +Please direct your attention to the [UserFrosting contribution guide](https://github.com/userfrosting/.github/blob/main/.github/CONTRIBUTING.md) diff --git a/README.md b/README.md index db1ee8bc..ecbce9c7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ https://learn.userfrosting.com -This is the repository for the documentation for UserFrosting 4. It is built with the flat-file CMS [Grav](http://getgrav.org), using their [RTFM skeleton](https://github.com/getgrav/grav-skeleton-rtfm-site#rtfm-skeleton). +This is the repository for the documentation for UserFrosting 5. It is built with the flat-file CMS [Grav](http://getgrav.org), using their [RTFM skeleton](https://github.com/getgrav/grav-skeleton-rtfm-site#rtfm-skeleton). ## Getting started @@ -17,8 +17,7 @@ This site is built using [Grav](https://learn.getgrav.org/) CMS, which like User To install a single copy of this branch (without multiple versions available), multiple installation methods are available: 1. [Local Installation](#local-installation) -2. [Lando](#lando) -3. [Docker](#docker) +2. [Docker](#docker) ### Local Installation @@ -53,25 +52,6 @@ htdocs/ └── ... ``` -### Lando - -1. Clone repo - ``` - git clone https://github.com/userfrosting/learn.git userfrosting-learn - cd userfrosting-learn - ``` - -2. Start Lando - ``` - lando start - ``` - -To stop the container: - -```bash -lando stop -``` - ### Docker 1. Clone repo @@ -87,10 +67,10 @@ lando stop 3. Start Grav container ``` - docker run -d --rm --name=learn -p 8080:80 -v "$(pwd):/var/www/grav/user" learn:latest + docker run -d --rm --name=learn -p 8888:80 -v "$(pwd):/var/www/grav/user" learn:latest ``` -It will take a couples of second for the site to be up and running while the base Grav installation is done. Once this is complete, you can access the documentation at [http://localhost:8080/](http://localhost:8080/). +It will take a couples of second for the site to be up and running while the base Grav installation is done. Once this is complete, you can access the documentation at [http://localhost:8888/](http://localhost:8888/). To stop the container: