-
Notifications
You must be signed in to change notification settings - Fork 201
Update GravCMS and plugins #317
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,134 @@ | ||
| # Drupal Commerce Documentation | ||
| #  Grav | ||
|
|
||
| **Contents:** | ||
| - [How to contribute to this documentation](#how-to-contribute-to-this-documentation) | ||
| - [Before your first contribution](#before-your-first-contribution) | ||
| - [Fast online contribution](#fast-online-contribution) | ||
| - [Local setup](#local-setup) | ||
| [](https://github.com/phpstan/phpstan) | ||
| [](https://insight.sensiolabs.com/projects/cfd20465-d0f8-4a0a-8444-467f5b5f16ad) | ||
| [](https://chat.getgrav.org) | ||
| [](https://travis-ci.org/getgrav/grav) [](#backers) [](#sponsors) | ||
|
|
||
| ## How to contribute to this documentation | ||
| Grav is a **Fast**, **Simple**, and **Flexible**, file-based Web-platform. There is **Zero** installation required. Just extract the ZIP archive, and you are already up and running. It follows similar principles to other flat-file CMS platforms, but has a different design philosophy than most. Grav comes with a powerful **Package Management System** to allow for simple installation and upgrading of plugins and themes, as well as simple updating of Grav itself. | ||
|
|
||
| ### Before your first contribution | ||
| The underlying architecture of Grav is designed to use well-established and _best-in-class_ technologies to ensure that Grav is simple to use and easy to extend. Some of these key technologies include: | ||
|
|
||
| **Before contributing**, you should consider the following: | ||
| - The documentation is written using [reStructuredText](http://docutils.sourceforge.net/rst.html) markup language. If you are not familiar with this format, read [this article](https://symfony.com/doc/current/contributing/documentation/format.html) for a quick overview of its basic features. | ||
| - The documentation is hosted on [GitHub](https://github.com). You'll need a free GitHub user account to contribute to the documentation. | ||
| - The documentation is published under a [Creative Commons BY-SA 4.0 License](https://github.com/drupalcommerce/commerce-docs/blob/master/LICENSE) and all your contributions will implicitly adhere to that license. | ||
| * [Twig Templating](https://twig.sensiolabs.org/): for powerful control of the user interface | ||
| * [Markdown](https://en.wikipedia.org/wiki/Markdown): for easy content creation | ||
| * [YAML](https://yaml.org): for simple configuration | ||
| * [Parsedown](https://parsedown.org/): for fast Markdown and Markdown Extra support | ||
| * [Doctrine Cache](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/caching.html): layer for performance | ||
| * [Pimple Dependency Injection Container](https://pimple.sensiolabs.org/): for extensibility and maintainability | ||
| * [Symfony Event Dispatcher](https://symfony.com/doc/current/components/event_dispatcher/introduction.html): for plugin event handling | ||
| * [Symfony Console](https://symfony.com/doc/current/components/console/introduction.html): for CLI interface | ||
| * [Gregwar Image Library](https://github.com/Gregwar/Image): for dynamic image manipulation | ||
|
|
||
| ### Fast online contribution | ||
| # Requirements | ||
|
|
||
| If you're making a relatively small change - like fixing a typo or rewording something - the easiest way to contribute is directly on GitHub! You can do this while you're reading this documentation. | ||
| - PHP 7.1.3 or higher. Check the [required modules list](https://learn.getgrav.org/basics/requirements#php-requirements) | ||
| - Check the [Apache](https://learn.getgrav.org/basics/requirements#apache-requirements) or [IIS](https://learn.getgrav.org/basics/requirements#iis-requirements) requirements | ||
|
|
||
| 1. Click on the **Edit on GitHub** button on the upper right corner and you'll be redirected to GitHub:  | ||
| 2. Click the **edit icon** to edit the documentation:  | ||
| 3. You will be asked to fork the repo, click **Fork this repository and propose changes**:  | ||
| 4. Edit the contents, describe your changes and click on the **Propose file change** button:  | ||
| 5. GitHub will now create a branch and a commit for your changes (forking the repository first if this is your first contribution) and it will also display a preview of your changes: If everything is correct, click on the **Create pull request** button. | ||
| 6. GitHub will display a new page where you can do some last-minute changes to your pull request before creating it. For simple contributions, you can safely ignore these options and just click on the **Create pull request** button again. | ||
| # QuickStart | ||
|
|
||
| **Congratulations!** You just created a pull request to the official Drupal Commerce documentation! The community will now review your pull request and (possibly) suggest tweaks. | ||
| These are the options to get Grav: | ||
|
|
||
| But if you want to contribute heavily, we recommend you doing a local setup of the documentation. | ||
| ### Downloading a Grav Package | ||
|
|
||
| ### Local setup | ||
| 1. Run composer install | ||
| 7. In the terminal generate user for admin panel `bin/plugin login newuser` | ||
| 8. Add credentials | ||
|  | ||
| 9. Login `php -S localhost:8000 system/router.php` | ||
| You can download a **ready-built** package from the [Downloads page on https://getgrav.org](https://getgrav.org/downloads) | ||
|
|
||
| ### Edit using Visual Code Studio | ||
| You can download Visual Code Studio and add the [reStructured Text](https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext) plugin to have an editor with built in previews available. | ||
| ### With Composer | ||
|
|
||
| ### Edit and review manually | ||
| 1. Execute `./build.sh`, this will generate documentation HTML inside `_build/html`. | ||
| 2. Now you can view the documentation locally, execute `php -S localhost:8000 -t _build/html` , and visit [http://localhost:8000/](http://localhost:8000/) from your browser. | ||
| You can create a new project with the latest **stable** Grav release with the following command: | ||
|
|
||
| That's it! | ||
| ``` | ||
| $ composer create-project getgrav/grav ~/webroot/grav | ||
| ``` | ||
|
|
||
| ### From GitHub | ||
|
|
||
| 1. Clone the Grav repository from [https://github.com/getgrav/grav]() to a folder in the webroot of your server, e.g. `~/webroot/grav`. Launch a **terminal** or **console** and navigate to the webroot folder: | ||
| ``` | ||
| $ cd ~/webroot | ||
| $ git clone https://github.com/getgrav/grav.git | ||
| ``` | ||
|
|
||
| 2. Install the **plugin** and **theme dependencies** by using the [Grav CLI application](https://learn.getgrav.org/advanced/grav-cli) `bin/grav`: | ||
| ``` | ||
| $ cd ~/webroot/grav | ||
| $ bin/grav install | ||
| ``` | ||
|
|
||
| Check out the [install procedures](https://learn.getgrav.org/basics/installation) for more information. | ||
|
|
||
| # Adding Functionality | ||
|
|
||
| You can download [plugins](https://getgrav.org/downloads/plugins) or [themes](https://getgrav.org/downloads/themes) manually from the appropriate tab on the [Downloads page on https://getgrav.org](https://getgrav.org/downloads), but the preferred solution is to use the [Grav Package Manager](https://learn.getgrav.org/advanced/grav-gpm) or `GPM`: | ||
|
|
||
| ``` | ||
| $ bin/gpm index | ||
| ``` | ||
|
|
||
| This will display all the available plugins and then you can install one or more with: | ||
|
|
||
| ``` | ||
| $ bin/gpm install <plugin/theme> | ||
| ``` | ||
|
|
||
| # Updating | ||
|
|
||
| To update Grav you should use the [Grav Package Manager](https://learn.getgrav.org/advanced/grav-gpm) or `GPM`: | ||
|
|
||
| ``` | ||
| $ bin/gpm selfupgrade | ||
| ``` | ||
|
|
||
| To update plugins and themes: | ||
|
|
||
| ``` | ||
| $ bin/gpm update | ||
| ``` | ||
|
|
||
|
|
||
| # Contributing | ||
| We appreciate any contribution to Grav, whether it is related to bugs, grammar, or simply a suggestion or improvement! Please refer to the [Contributing guide](CONTRIBUTING.md) for more guidance on this topic. | ||
|
|
||
| ## Security issues | ||
| If you discover a possible security issue related to Grav or one of its plugins, please email the core team at contact@getgrav.org and we'll address it as soon as possible. | ||
|
|
||
| # Getting Started | ||
|
|
||
| * [What is Grav?](https://learn.getgrav.org/basics/what-is-grav) | ||
| * [Install](https://learn.getgrav.org/basics/installation) Grav in few seconds | ||
| * Understand the [Configuration](https://learn.getgrav.org/basics/grav-configuration) | ||
| * Take a peek at our available free [Skeletons](https://getgrav.org/downloads/skeletons) | ||
| * If you have questions, jump on our [Discord Chat Server](https://chat.getgrav.org)! | ||
| * Have fun! | ||
|
|
||
| # Exploring More | ||
|
|
||
| * Have a look at our [Basic Tutorial](https://learn.getgrav.org/basics/basic-tutorial) | ||
| * Dive into more [advanced](https://learn.getgrav.org/advanced) functions | ||
| * Learn about the [Grav CLI](https://learn.getgrav.org/cli-console/grav-cli) | ||
| * Review examples in the [Grav Cookbook](https://learn.getgrav.org/cookbook) | ||
| * More [Awesome Grav Stuff](https://github.com/getgrav/awesome-grav) | ||
|
|
||
| # Backers | ||
| Support Grav with a monthly donation to help us continue development. [[Become a backer](https://opencollective.com/grav#backer)] | ||
|
|
||
| <img src="https://opencollective.com/grav/tiers/backers.svg?avatarHeight=36&width=600" /> | ||
|
|
||
| # Sponsors | ||
| Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/grav#sponsor)] | ||
|
|
||
| <img src="https://opencollective.com/grav/tiers/sponsors.svg?avatarHeight=36&width=600" /> | ||
|
|
||
| # License | ||
|
|
||
| See [LICENSE](LICENSE.txt) | ||
|
|
||
|
|
||
| [gitflow-model]: http://nvie.com/posts/a-successful-git-branching-model/ | ||
| [gitflow-extensions]: https://github.com/nvie/gitflow | ||
|
|
||
| # Running Tests | ||
|
|
||
| First install the dev dependencies by running `composer update` from the Grav root. | ||
| Then `composer test` will run the Unit Tests, which should be always executed successfully on any site. | ||
| Windows users should use the `composer test-windows` command. | ||
| You can also run a single unit test file, e.g. `composer test tests/unit/Grav/Common/AssetsTest.php` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤦♂ forgot this overrides our custom README.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That happened last time, too. We can just merge this and then I can open a second PR to restore the original/custom README.