Merge pull request #3403 from danny007in/docs-branch

.github/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+
+# 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.
+    * 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).
+2. Installation :
+    * Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
+    * Clone to your machine
+
+    ```bash
+    git clone https://github.com/YOUR_USERNAME/AdminLTE.git
+    ```
+    * Create a new branch
+3. Compile dist files (Development) :
+    * To compile the dist files you need Node.js 10 or higher/npm (node package manager)
+    * Delete ./package-lock.json file
+    * `npm install` (install npm deps)
+    * `npm run dev` (developer mode, autocompile with browsersync support for live demo)
+    * Make your changes only in ./buid Folder OR package.json OR ./dist/js/demo.js OR in any html files which nessary to contribute
+    * Do not changes in ./dist/css/ AND ./dist/js/ Because its compiled files
+    * `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
+
+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 `npm run dev` to start the server.
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)

README.md

@@ -1,4 +1,4 @@
-# Introduction
+# [AdminLTE - Bootstrap 4 Admin Dashboard](https://adminlte.io)
 
 [![npm version](https://img.shields.io/npm/v/admin-lte/latest.svg)](https://www.npmjs.com/package/admin-lte)
 [![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte)
@@ -20,7 +20,7 @@ prices. Visit <https://adminlte.io/premium> for more information.
 **AdminLTE** has been carefully coded with clear comments in all of its JS, SCSS and HTML files.
 SCSS has been used to increase code customizability.
 
-## Installation
+## Quick start
 
 There are multiple ways to install AdminLTE.
 
@@ -83,43 +83,6 @@ updated guide. Information will be added on a weekly basis.
 | --------- | --------- | --------- | --------- | --------- | --------- | --------- | --------- | --------- |
 | IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions
 
-## How to Contribute
-
-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. 
-    * 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).
-2. Installation :
-    * Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
-    * Clone to your machine
-
-    ```bash
-    git clone https://github.com/YOUR_USERNAME/AdminLTE.git
-    ```
-    * Create a new branch
-3. Compile dist files (Development) :
-    * To compile the dist files you need Node.js 10 or higher/npm (node package manager)
-    * Delete ./package-lock.json file
-    * `npm install` (install npm deps)
-    * `npm run dev` (developer mode, autocompile with browsersync support for live demo)
-    * Make your changes only in ./buid Folder OR package.json OR ./dist/js/demo.js OR in any html files which nessary to contribute
-    * Do not changes in ./dist/css/ AND ./dist/js/ Because its compiled files
-    * `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
-
-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.
-
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
-
 ### Compile dist files
 
 To compile the dist files you need Node.js/npm, clone/download the repo then:
@@ -128,6 +91,14 @@ To compile the dist files you need Node.js/npm, clone/download the repo then:
 2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo)
 3. `npm run production` (compile css/js files)
 
+
+## Contributing
+
+Please read through our [contributing guidelines](https://github.com/ColorlibHQ/AdminLTE/tree/master/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
+
+Editor preferences are available in the [editor config](https://github.com/twbs/bootstrap/blob/main/.editorconfig) for easy use in common text editors. Read more and download plugins at <https://editorconfig.org/>.
+
+
 ## License
 
 AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT).

build/npm/DocsPublish.js

@@ -4,6 +4,7 @@
 
 const path = require('path')
 const fse = require('fs-extra')
+const fs = require('fs')
 const Plugins = require('./DocsPlugins')
 
 class Publish {
@@ -47,6 +48,10 @@ class Publish {
         console.error(`Error: ${error}`)
       }
     })
+
+    const insertText = '---\r\nlayout: page\r\ntitle: \r\n---\r\n'
+
+    fs.writeFileSync('docs/how-to-contribute.md', insertText + fs.readFileSync('.github/CONTRIBUTING.md', 'utf8'))
   }
 }
 

docs/_config.yml

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

docs/_layouts/page.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>

docs/how-to-contribute.md

@@ -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.
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](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)

package.json

@@ -38,7 +38,7 @@
     "js-minify": "terser --compress typeofs=false --mangle --comments \"/^!/\" --source-map \"content=dist/js/adminlte.js.map,includeSources,url=adminlte.min.js.map\" --output dist/js/adminlte.min.js dist/js/adminlte.js",
     "js-lint": "eslint --cache --cache-location .cache/.eslintcache --report-unused-disable-directives .",
     "lint": "npm-run-all --continue-on-error --parallel css-lint js-lint lockfile-lint",
-    "production": "npm-run-all compile plugins",
+    "production": "npm-run-all --parallel compile plugins",
     "prepare-release": "npm-run-all production docs",
     "test": "npm-run-all lint production",
     "plugins": "node build/npm/Publish.js -v",