GNOME.org
 

[gtk-web/new-website: 181/191] configured the website and added some issue templates

commit a8112554975e0bc0a79c39a68b4fce85b4d66ecd
Author: ravgeetdhillon <ravgeetdhillon gmail com>
Date:   Sun Aug 25 18:11:00 2019 +0530

    configured the website and added some issue templates

 .gitlab-ci.yml                     | 40 +++-----------------------------------
 .gitlab/issue_templates/Bug.md     |  2 +-
 .gitlab/issue_templates/Feature.md |  8 ++++++++
 CONTRIBUTING.md                    | 12 ++++++++----
 README.md                          | 40 +++++++++++++-------------------------
 main.sh                            |  3 +++
 scripts/compile-sass.sh            |  2 +-
 scripts/get-api-data.sh            |  4 +---
 scripts/structurize.sh             |  2 --
 9 files changed, 39 insertions(+), 74 deletions(-)
---
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index fcc60fd..4edba36 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -4,52 +4,18 @@ variables:
   JEKYLL_ENV: production
   LC_ALL: C.UTF-8
 
-stages:
-  - download
-  - structuring
-  - generation
-  - test
-  - deploy
-
 before_script:
   - apt-get update -y
   - apt-get install -y curl
-  - gem install bundler jekyll
-  - bundle install
-
-npm:
-  stage: download
-  script:
   - curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash
   - source /root/.bashrc
   - nvm install node
   - nvm use node
   - npm install
-  artifacts:
-    paths:
-    - node_modules
-
-api:
-  stage: download
-  script:
-  - chmod +x scripts/get-api-data.sh
-  artifacts:
-    paths:
-    - _data/api_fetch
-
-structuring:
-  stage: structuring
-  script:
-  - chmod +x scripts/structurize.sh
-  artifacts:
-    paths:
-    - assets
+  - gem install bundler jekyll
+  - bundle install
+  - chmod +x main.sh
 
-sass:
-  stage: generation
-  script:
-  - chmod +x scripts/compile-sass.sh
-  
 test:
   stage: test
   script:
diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md
index 2703893..1b7a574 100644
--- a/.gitlab/issue_templates/Bug.md
+++ b/.gitlab/issue_templates/Bug.md
@@ -22,4 +22,4 @@ Use code blocks (```) to format them.
 
 What did you expect to see instead?
 
-/label ~"1. Bug"
\ No newline at end of file
+/label ~"Bug"
\ No newline at end of file
diff --git a/.gitlab/issue_templates/Feature.md b/.gitlab/issue_templates/Feature.md
new file mode 100644
index 0000000..c9aaddb
--- /dev/null
+++ b/.gitlab/issue_templates/Feature.md
@@ -0,0 +1,8 @@
+# Feature information #
+
+## Idea ##
+
+- Specify your idea clearly.
+- If possible, provide some reference resources so that we can get a better picture of feature that you are 
requesting.
+
+/label ~"Feature"
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5ed938a..71c9731 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,7 +4,7 @@ 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.
+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 
even your small contribution can make a huge impact on the community.
 
 ## Read this first
 
@@ -25,7 +25,6 @@ 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
 
@@ -42,9 +41,10 @@ permalink: /path/to/:name
 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/blog/adding-pages-to-jekyll-site/) on how to add documentation pages 
to the GTK website.
+> If want a more detailed explanation about how to do the thing, you can check this [blog 
post](https://ravgeetdhillon.github.io/blog/adding-pages-to-jekyll-site/) by [Ravgeet 
Dhillon](https://gitlab.gnome.org/ravgeetdhillon/) 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>`
@@ -56,6 +56,10 @@ where
 

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`

 
+### Links and Paths
+
+All the links and paths are relative to the website URL. Donot give absolute URLs for lniks, images, scripts 
or any other resources that use the `path` attribute. Use of absolute URL is only appreciable when refering 
to am external resource.
+
 ### Adding/Updating/Removing Dependencies
 
 1. Create a local clone of the website:
@@ -90,7 +94,7 @@ $ cd gtk-web
 ## How to submit a contribution
 
 #### For listing bugs
-1. Open an issue and provide us with appropriate information using our Issue Template.
+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
diff --git a/README.md b/README.md
index 34dfa23..a1d090c 100644
--- a/README.md
+++ b/README.md
@@ -70,34 +70,29 @@ We always welcome people who want to contribute towards our project. For suitabl
 To get the site up and running locally, follow the below steps:
 
 1. Install a full [Ruby development environment](https://jekyllrb.com/docs/installation/).
-2. Install Jekyll and [bundler](https://jekyllrb.com/docs/ruby-101/#bundler) 
[gems](https://jekyllrb.com/docs/ruby-101/#gems).
-```shell
-gem install bundler jekyll
-```
-3. Create a local clone of the website:
+2. Create a local clone of the website:
 ```git
 git clone https://gitlab.gnome.org/ravgeetdhillon/gtk-web.git
 ```
-4. Change into the gtk-web directory
+3. Change into the gtk-web directory
 ```shell
 cd gtk-web
 ```
-5. Install the NPM and Gem dependencies by running the following commands:
+4. Install the NPM and Gem dependencies by running the following commands:
 ```shell
 npm install
+gem install bundler jekyll
 bundle install
 ```
-6. Perform the following commands to install and structure the website properly:
+5. Perform the following commands to structure the website properly:
 ```shell
-scripts/structurize.sh
-scripts/compile-sass.sh
-scripts/get-api-fetch.sh
+main.sh
 ```
-7. Build the site and make it available on a local server
+6. Build the site and make it available on your local server
 ```shell
 $ bundle exec jekyll serve
 ```
-8. Browse to [http://localhost:4000](http://localhost:4000) to view the website.
+7. Browse to [http://localhost:4000](http://localhost:4000) to view the website.
 
 ## Dependencies
 
@@ -120,17 +115,9 @@ Read about adding/updating/removing dependencies on [how to contribute](CONTRIBU
 
 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.
-
-GTK.org builds in four stages:
-
-* installation
-* structuring
-* generation
-* test
-* deploy
+The pipeline defined by the GTK.org uses the `Ruby2.5` image. The pipeline consists of a script that runs 
before the site is tested/deployed. The script that runs before the test/deployment of the website basically 
installs all the `gem/npm dependencies`, fetches the API data regarding the GTK from its [gitlab 
instance][gtk-gitlab] and then structurizes the website before testing/deploying.
 
-Each stage has certain jobs associated with it. `installation`, `structuring` and `generation` are primary 
stages common to all the branches. `test` stage is performed on all branches except `master`. `deploy` stage 
on the other hand is performed only on `master` branch.
+`test` stage is performed on all branches but `master`. `deploy` stage on the other hand is performed only 
on `master` branch.
 

If you think that there can be a better pipeline than the existing one, send us a merge request for the 
same.

 
@@ -139,12 +126,12 @@ Each stage has certain jobs associated with it. `installation`, `structuring` an
 You can reach out to the following individuals if you have any doubt or suggestion regarding the GTK.org:
 
 **Ravgeet Dhillon**
-* You can contanct Ravgeet via my [email](mailto:ravgeetdhillon gmail com).
+* You can contact me via my [email](mailto:ravgeetdhillon gmail com) or through my 
[website](https://ravgeetdhillon.github.io).
 * You can also find me on IRC. I am `ravgeetdhillon` on `irc.gnome.org` in the `#gtk` or
   `#gnome-hackers` channels.
 
 **Emmanuele Bassi**
-* You can contact me Emmanuele my [email](mailto:ebassi gnome org).
+* You can contact me via my [email](mailto:ebassi gnome org).
 
 ## Code of Conduct
 
@@ -161,4 +148,5 @@ GTK.org is licensed under the [Creative Commons BY-SA-4.0][license].
 [official-jekyll]: https://jekyllrb.com
 [package.json]: package.json
 [Gemfile]: Gemfile
-[license]: LICENSE.txt
\ No newline at end of file
+[license]: LICENSE.txt
+[gtk-gitlab]: https://gitlab.gnome.org/GNOME/gtk/
\ No newline at end of file
diff --git a/main.sh b/main.sh
new file mode 100644
index 0000000..b4ebe32
--- /dev/null
+++ b/main.sh
@@ -0,0 +1,3 @@
+chmod +x scripts/get-api-data.sh
+chmod +x scripts/structurize.sh
+chmod +x scripts/compile-sass.sh
\ No newline at end of file
diff --git a/scripts/compile-sass.sh b/scripts/compile-sass.sh
index e3000f7..50a7ffe 100644
--- a/scripts/compile-sass.sh
+++ b/scripts/compile-sass.sh
@@ -1,5 +1,5 @@
 echo 'compiling scss to css...'
 
-sass ./assets/scss/theme.scss ./assets/css/theme.css
+npm run sass
 
 echo 'successfully compiled all scss files to css'
\ No newline at end of file
diff --git a/scripts/get-api-data.sh b/scripts/get-api-data.sh
index 8dbc4ed..960b2bb 100644
--- a/scripts/get-api-data.sh
+++ b/scripts/get-api-data.sh
@@ -18,6 +18,4 @@ echo 'successfully fetched gtk-issue-statistics'
 
 curl https://gitlab.gnome.org/api/v4/projects/665/issues?state=opened > ./_data/api_fetch/issues_opened.json
 
-echo 'successfully fetched gtk-issues'
-
-ls ./_data/api_fetch
\ No newline at end of file
+echo 'successfully fetched gtk-issues'
\ No newline at end of file
diff --git a/scripts/structurize.sh b/scripts/structurize.sh
index e5372e2..16c0bb8 100644
--- a/scripts/structurize.sh
+++ b/scripts/structurize.sh
@@ -1,7 +1,5 @@
 echo 'structurizing the website...'
 
-ls ./node_modules
-
 mv ./node_modules/* ./assets/ -f
 
 rm -rf ./node_modules
\ No newline at end of file
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]