improve docs
This commit is contained in:
2
docs/_config.yml
vendored
2
docs/_config.yml
vendored
@@ -86,7 +86,7 @@ navigation:
|
||||
url: upgrade-guide.html
|
||||
icon: fas fa-hand-point-up
|
||||
- title: Contributing Guide
|
||||
url: contributing.html
|
||||
url: how-to-contribute.html
|
||||
icon: fas fa-hands-helping
|
||||
- title: FAQ
|
||||
url: faq.html
|
||||
|
||||
@@ -3,10 +3,11 @@ layout: default
|
||||
---
|
||||
|
||||
<div class="content-wrapper px-4 py-2">
|
||||
{% if page.title and page.title != blank %}
|
||||
<div class="content-header">
|
||||
<h1>{{ page.title }}</h1>
|
||||
</div>
|
||||
|
||||
{% endif %}
|
||||
<div class="content px-2">
|
||||
{{ content }}
|
||||
</div>
|
||||
|
||||
20
docs/contributing.md → docs/how-to-contribute.md
vendored
20
docs/contributing.md → docs/how-to-contribute.md
vendored
@@ -1,12 +1,14 @@
|
||||
---
|
||||
layout: page
|
||||
title: Contributing Guide
|
||||
title:
|
||||
---
|
||||
|
||||
# Contributing to AdminLTE
|
||||
|
||||
Contributions are always **welcome and recommended**! Here is how for beginner's: [Get started with open source click here](https://youtu.be/GbqSvJs-6W4)
|
||||
|
||||
1. Contribution Requirements :
|
||||
* When you contribute, you agree to give a non-exclusive license to AdminLTE.io to use that contribution in any context as we (AdminLTE.io) see appropriate.
|
||||
1. Contribution Requirements :
|
||||
* When you contribute, you agree to give a non-exclusive license to AdminLTE.io to use that contribution in any context as we (AdminLTE.io) see appropriate.
|
||||
* If you use content provided by another party, it must be appropriately licensed using an [open source](https://opensource.org/licenses) license.
|
||||
* Contributions are only accepted through GitHub pull requests.
|
||||
* Finally, contributed code must work in all supported browsers (see above for browser support).
|
||||
@@ -28,20 +30,12 @@ Contributions are always **welcome and recommended**! Here is how for beginner's
|
||||
* `npm run production` (compile css/js files and test every pages are perfectly working fine, before creating pull request)
|
||||
4. Create a pull request
|
||||
|
||||
### Online one-click setup for contributing
|
||||
## Online one-click setup for contributing
|
||||
|
||||
You can use Gitpod(an online IDE which is free for Open Source) for working on issues or making Prs. With a single click it will launch a workspace and automatically:
|
||||
|
||||
- clone the `AdminLTE` repo.
|
||||
- install the dependencies.
|
||||
- run `yarn dev` to start the server.
|
||||
- run `npm run dev` to start the server.
|
||||
|
||||
[](https://gitpod.io/from-referrer/)
|
||||
|
||||
### Compile dist files
|
||||
|
||||
To compile the dist files you need Node.js/npm, clone/download the repo then:
|
||||
|
||||
1. `npm install` (install npm deps)
|
||||
2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo)
|
||||
3. `npm run production` (compile css/js files)
|
||||
Reference in New Issue
Block a user