GNOME.org
 

[gtk-web/new-website: 109/191] updated documentation

commit ef613a9ef622e3b238f7d7570963a9ca68976deb
Author: ravgeetdhillon <ravgeetdhillon gmail com>
Date:   Tue Jul 16 22:10:59 2019 +0530

    updated documentation

 CONTRIBUTING.md                                    |  39 ++++++-
 README.md                                          |  12 +++
 _config.yml                                        |   6 +-
 _data/stuff.yml                                    |   4 +-
 ...me-horizontal.svg => logo-gnome-horizontal.svg} |   0
 collections/_docs/CONTRIBUTING.md                  | 118 +++++++++++++++++++++
 6 files changed, 170 insertions(+), 9 deletions(-)
---
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d259ae5..58ffa6c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,9 @@
+---
+permalink: /contributing
+layout: documentation
+output: true
+---
+
 # Contributing to GTK.org
 
 GTK.org welcomes everyone to contribute to the GTK.org. We really appreciate the efforts of people who help 
us in keeping the website updated. GTK.org is visted everyday by large number of developers and end users, so 
your contribution make a huge impact on the community.
@@ -21,6 +27,35 @@ GTK.org is an open source project and we love to receive contributions from our
 * New Content
 * Blog Posts
 * Usecase Studies
+* Adding/Updating/Removing Dependencies
+
+#### Adding Documentation pages
+
+> Documentation pages are those which are listed under the `/docs/*` URL pattern.
+
+#### Adding/Updating/Removing Dependencies
+**Adding Dependency**
+To add a new dependency, run the following command:
+```
+$ npm install <package-name> --save
+```
+
+**Updating Dependency**
+To add update a particular dependency, run the following command:
+```
+$ npm update <package-name> --save
+```
+
+To add update all the dependencies, run the following command:
+```
+$ npm update --save
+```
+
+**Removing Dependency**
+To remove a new dependency, run the following command:
+```
+npm uninstall <package-name> --save
+```
 
 ### How to submit a contribution
 
@@ -46,7 +81,7 @@ If you find yourself wishing for a something that doesn't exist in GTK.org, you

Actual behaviour. Tell us what should happens instead

 
 # Community
-You can chat with the core team on IRC. The core is available to discuss about the things that can make the 
website better.
-
+You can chat with the core team on IRC. The core team is available to discuss about the things that can make 
the website better.
 
+<!-- markdown variables -->
 [code-of-conduct]: CODE_OF_CONDUCT.MD
\ No newline at end of file
diff --git a/README.md b/README.md
index 3390517..f680ad0 100644
--- a/README.md
+++ b/README.md
@@ -107,6 +107,18 @@ popper.js | `1.15.0` | [package.json][package.json] | [Github](https://github.co
 slick-carousel | `1.8.1` | [package.json][package.json] | [Github](https://github.com/kenwheeler/slick)
 jekyll | `3.8.5` | [Gemfile][Gemfile] | [Github](https://github.com/jekyll/jekyll/)
 
+Read about adding/updating/removing dependencies on [how to 
contribute](CONTRIBUTING.MD#addingupdatingremoving-dependencies).
+
+## Pipeline
+
+> Currently the pipeline hasn't been optimized because the website reworking is still going on.
+
+The pipeline used by the website is the top-level component of continuous integration, delivery, and 
deployment.
+
+The pipeline defined by the GTK.org uses the `Ruby2.5` image. There are different jobs that are happening 
across a pipeline in different stages. The jobs define what to run and stages define when and how to run. If 
a pipeline completes successfully without any error, then the final site is built into the `public` directory 
and is available for download as an artifact.
+
+If you think that there can be a better pipeline than the existing one, send us a merge request for the same.
+
 ## Maintainers
 
 You can reach out to the following individuals if you have any doubt or suggestion regarding the GTK.org:
diff --git a/_config.yml b/_config.yml
index 180fe61..0c267a3 100644
--- a/_config.yml
+++ b/_config.yml
@@ -10,8 +10,6 @@ kramdown:
 highlighter: rouge
 # plugins:
 #   - jekyll-feed
-# sass:
-#   sass_dir: _sass
 # include:
 #   - .htaccess
 exclude: 
@@ -26,9 +24,7 @@ exclude:
   - CONTRIBUTING.md
   - CODE_OF_CONDUCT.md
   - LICENSE.txt
-
-# for dev only
-# keep_files: [assets]
+  - structurize.sh
 
 collections_dir: collections
 
diff --git a/_data/stuff.yml b/_data/stuff.yml
index f03f173..dc8926b 100644
--- a/_data/stuff.yml
+++ b/_data/stuff.yml
@@ -19,7 +19,7 @@ website_logo: gtk-logo.ico
 
 # to add sections to the sidebar on the documentation pages of the website, add a section with the following 
attributes:
 #   title: the display text for the section
-#   name: the name of the file
+#   name: the name of the `.md` file in '/collection/_docs', to which the link should point
 sidebar_sections:
   - title: Getting Started
     name: getting-started
@@ -36,7 +36,7 @@ sidebar_sections:
 
 # to add links to the sidebar on the documentation pages of the website, add a link with the following 
attributes:
 #   title: the display text for the section
-#   name: the name of the `.md` file, to which the link should point
+#   name: the name of the `.md` file in '/collection/_docs', to which the link should point
 #   section: the name of the section the link belongs to
 sidebar_links:
   - title: Mono Develop
diff --git a/assets/img/logognome-horizontal.svg b/assets/img/logo-gnome-horizontal.svg
similarity index 100%
rename from assets/img/logognome-horizontal.svg
rename to assets/img/logo-gnome-horizontal.svg
diff --git a/collections/_docs/CONTRIBUTING.md b/collections/_docs/CONTRIBUTING.md
new file mode 100644
index 0000000..54fb69d
--- /dev/null
+++ b/collections/_docs/CONTRIBUTING.md
@@ -0,0 +1,118 @@
+---
+permalink: /contributing
+---
+
+# Contributing to GTK.org
+
+GTK.org welcomes everyone to contribute to the GTK.org. We really appreciate the efforts of people who help 
us in keeping the website updated. GTK.org is visted everyday by large number of developers and end users, so 
your contribution make a huge impact on the community.
+
+## Read this first
+
+We suggest you to take a moment to review this document in order to make the contribution process easy and 
effective for everyone involved.
+
+In order to maintain a uniformity across the website, we have made a certain set of rules and templates that 
you should follow in order to provide us with useful contributions. Following these guidelines will help to 
communicate that you respect the time of the developers managing and developing the website. In return, they 
should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your 
pull requests.
+
+As for everything else in the project, the contributions to GTK.org are governed by our [Code of 
Conduct][code-of-conduct].
+
+## What can you contribute
+
+GTK.org is an open source project and we love to receive contributions from our community — you! You can 
contribute to the GTK.org in any way you want, that has the potential to make GTK.org a better website. Some 
common ways to contribute are listed below:
+* Improving documentation
+* Bug Tracking
+* Feature Requests
+* Design Refactoring
+* Images and Illustrations
+* New Content
+* Blog Posts
+* Usecase Studies
+* Adding/Updating/Removing Dependencies
+
+### Adding Documentation pages
+
+Documentation pages are those which are listed under the `/docs/*` URL pattern.
+
+To add a new documentation page, follow the steps below:
+1. Add a new `.md` file with the following naming convention:
+  * `<doc-page-name>.md` where `<doc-page-name>` is the name of the page. (Name should be assigned according 
to how it will appear in the URL)
+2. In this new Markdown file, add the following front matter along with the file's content:
+```
+permalink: /path/to/:name
+# specifies the URL path of the file which will be appended to the site's url
+```
+3. Add the information about the new file to [/_data/stuff.yml](/_data/stuff.yml).
+4. Send a merge request using one of the merge request template.
+
+> If you are in doubt, check this [blog post](https://ravgeetdhillon.github.io/) on how to add documentation 
pages to the GTK website.
+
+### Images and Illustrations
+All the images and illustrations are present in the [assets/img][image-directory] directory. The following 
naming convention should be used when new images or illustrations are to be added:
+
+`<role>-<name>.<ext>`
+
+where
+* `<role>` is the context for which the image is used in the website. For example if the image is going to 
be used in documentation pages, the `<role>` would be doc
+* `<name>` is the name of the image. (Make sure that you provide a unique name for the image)
+* `<ext>` is the extension of the image. Valid extensions are `.jpg`, `.jpeg`, `.svg`, `.png` and others. 
(Make sure that the images/illustrations you provide are optimized for size and quality)
+
+> A valid image name for an image to be used as a wallpaper or just a display image is: `wall-computer.png` 
or `wallpaper-computer.png`
+
+### Adding/Updating/Removing Dependencies
+
+1. Create a local clone of the website:
+```
+$ git clone https://gitlab.gnome.org/ravgeetdhillon/gtk-web.git
+```
+2. Change into the gtk-web directory:
+```
+$ cd gtk-web
+```
+3. Based on what you want to do, proceed further as given below:
+  * #### Adding Dependency
+  To add a new dependency, run the following command:
+  ```
+  $ npm install <package-name> --save
+  ```
+  * #### Updating Dependency
+  To add update a particular dependency, run the following command:
+  ```
+  $ npm update <package-name> --save
+  ```
+  To add update all the dependencies, run the following command:
+  ```
+  $ npm update --save
+  ```
+  * #### Removing Dependency
+  To remove a new dependency, run the following command:
+  ```
+  $ npm uninstall <package-name> --save
+  ```
+
+## How to submit a contribution
+
+#### For listing bugs
+1. Open an issue and provide us with appropriate information using our Issue Template.
+2. (Optional) If you can solve the issue filed by you, read below on how to submit a pull request.
+
+#### For feature requests
+If you find yourself wishing for a something that doesn't exist in GTK.org, you are probably not alone. Open 
an issue which describes the feature you would like to see, how it would affect the community, and how it 
should work.
+
+#### For sending Pull Requests
+1. Create your own fork of the code.
+2. Do the changes in your fork.
+3. Send us a pull request with appropriate information using our Pull Request Template.
+
+### Issue Template for GTK.org.
+> Subject of the issue
+> Describe your issue here.
+> Your environment
+> which browser and its version
+> Tell us how to reproduce this issue. Please provide a working demo, you can use this template as a base.
+> Expected behaviour. Tell us what should happen
+> Actual behaviour. Tell us what should happens instead
+
+# Community
+You can chat with the core team on IRC. The core is available to discuss about the things that can make the 
website better.
+
+<!-- markdown variables -->
+[code-of-conduct]: CODE_OF_CONDUCT.MD
+[image-directory]: assets/img
\ No newline at end of file
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]