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



commit cc9238924a3fc5134c3b931d0fd07d45adce9d9c
Author: ravgeetdhillon <ravgeetdhillon gmail com>
Date:   Sun Jul 14 22:39:57 2019 +0530

    updated documentation

 .gitlab/issue_templates/Bug.md |  0
 CONTRIBUTING.md                |  2 +-
 _data/apps.yml                 | 12 ++++++++++++
 _data/navigation.yml           | 18 ++++++++++++++++++
 4 files changed, 31 insertions(+), 1 deletion(-)
---
diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md
new file mode 100644
index 0000000..e69de29
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e0bbdb3..d259ae5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -26,7 +26,7 @@ GTK.org is an open source project and we love to receive contributions from our
 
 #### 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 reuqest.
+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.
diff --git a/_data/apps.yml b/_data/apps.yml
index c4eb3fd..17b7432 100644
--- a/_data/apps.yml
+++ b/_data/apps.yml
@@ -1,3 +1,15 @@
+# This file contains the apps added in the slider section on the index.html
+
+# To add apps to the slider section, add an app with the following attributes:
+#   name: name of the app
+#   link: provide the source/link to visit or download the app
+#   logo: file name of the app's logo
+
+# Add the logo image for the app in the assets/img/apps.
+# The name of the logo image for the app should have the following naming convention
+#   <app-name>-app.<image-ext>
+# Make sure that the logo image have square dimensions
+
 apps_list:
   - name: Fonts
     link: /apps/
diff --git a/_data/navigation.yml b/_data/navigation.yml
index 2258953..759afe9 100644
--- a/_data/navigation.yml
+++ b/_data/navigation.yml
@@ -1,3 +1,17 @@
+# This file contains the navigation links present in the header and footer of the website
+
+# To add navigation links to the website, add a new link with the following attributes:
+#   name: display text of the link
+#   href: the location where the link points to
+#   header: set this to 'true' if the link should be present in the header, else set 'false'
+#   footer: set this to 'true' if the link should be present in the footer, else set 'false'
+#   section: if footer is set to 'true', specify the name of the section the link belongs
+
+# sections in footer are:
+#   Project
+#   Company
+#   Support
+
 menu_links:
   - name: GTK
     href: /
@@ -90,6 +104,10 @@ menu_links:
     footer: true
     section: Support
 
+# To add social links to the website, add a new social link with the following attributes:
+#   icon: the name of the icon on https://fontawesome.com/icons
+#   href: link to the social media profile
+
 social_links:
   - icon: fab fa-twitter
     href: https://twitter.com/GTKtoolkit/


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]