Skip to content

Commit

Permalink
Update README, metadata & remove Lando
Browse files Browse the repository at this point in the history
  • Loading branch information
lcharette committed Apr 28, 2024
1 parent a474648 commit 291ec71
Show file tree
Hide file tree
Showing 8 changed files with 71 additions and 80 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ ehthumbs.db
Icon?
Thumbs.db
*.swp
.vscode

# Custom
_meta
Expand Down
24 changes: 0 additions & 24 deletions .lando.dist.sh

This file was deleted.

22 changes: 0 additions & 22 deletions .lando.dist.yml

This file was deleted.

7 changes: 7 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"streetsidesoftware.code-spell-checker",
"bierner.markdown-preview-github-styles",
"fcrespo82.markdown-table-formatter"
]
}
18 changes: 18 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"cSpell.diagnosticLevel": "Information",
"cSpell.words": [
"autowire",
"Birke",
"charette",
"Grav",
"Laravel",
"Mele",
"middlewares",
"phpstan",
"Phpunit",
"Rememberme",
"Sprunje",
"UserFrosting",
"weissman"
],
}
40 changes: 40 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -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"
}
]
}
11 changes: 2 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
28 changes: 4 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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:

Expand Down

0 comments on commit 291ec71

Please sign in to comment.