Verified Commit c7074a0e authored by exprez135's avatar exprez135

Documentation and Info

parent 96a181c1
/* Enable if we want headers to be numbered like e.g. 1.1 for H2 1.1.3 for H3 */
/*@import "plugins/numbered";*/
p,
.markdown li {
font-family: 'Charter-Racket', 'Roboto', sans-serif;
body {
font-family: 'Fira', 'Roboto', sans-serif;
}
strong {
font-family: Charter-Racket
p,
.markdown li,
.markdown strong {
font-family: 'Charter-Racket', 'Roboto', sans-serif;
}
.markdown h1,
......@@ -19,7 +20,21 @@ strong {
font-family: 'Fira', 'Roboto', sans-serif;
}
.markdown h1 {
padding-top: .75em;
}
.markdown table {
}
.book-menu,
.book-toc {
.book-toc,
.book-hint,
.book-hint strong {
font-family: 'Fira', 'Roboto', sans-serif;
}
.code {
font-family: 'Fira-Mono', 'Roboto Mono', monospace;
}
......@@ -57,12 +57,12 @@ params:
# Set source repository location.
# Used for 'Last Modified' and 'Edit this page' links.
BookRepo: https://git.sr.ht/~exprez135/culturebridge-hugo
BookRepo: https://gitlab.com/exprez135/culturebridge-hugo
# Enable "Edit this page" links for 'doc' page type.
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
# Edit path must point to root directory of repo.
# BookEditPath: edit/master/exampleSite
BookEditPath: edit/master/
# Configure the date format used on the pages
# - In git information
......
---
title: "Documentation"
weight: 100
bookFlatSection: false
bookToc: true
bookHidden: false
bookCollapseSection: false
bookComments: true
---
# The CultureBridge Manual - site documentation
Hey all! This is going to be a longer post, but consider it essential and necessary. Plus, who wouldn't want to read a ton of what Nate writes???
So, what's going on?
I decided to re-consider the steps I've taken thus far when it comes to the online form of the Manual. First, I realized that though WikiMedia is a great platform (I mean, it runs the best site on Earth), it is still a really different platform. To properly use it we would all need to learn how to use a special markup language. Plus, the site is pretty slow and it wouldn't lend itself to simple deployments to the final site.
{{< hint info >}}
**Note**
Don't worry! This page will be edited before we release anything so we aren't *too* unprofessional ;)
{{< /hint >}}
Instead, I figured that it would be best to look at POM when it comes to the platform:
## overview
### Purpose, Outcomes, and Methods
**Purpose**: To easily and effectively communicate the CultureBridge project to site visitors.
**Outcomes**:
- Portability: a site which can last forever with very little maintenance. This really means:
- Universal input: a form of writing which is well-supported across the web.
- Universal output: a static site (plain HTML, CSS, & JS) - which can be run from files on your computer or a website
- Multi-format: the ability to download the entire site in HTML, PDF, markdown, etc.
- Ease-of-use: both for the end-user and for us – the writers. The website should be easy to navigate. We need something which is easy to learn how to use.
- Beautiful: the simple fact is, a beautiful site which focuses on content is better for the situation.
Version control: a permanent record of changes and additions (not just for us, but for future creators).
**Methods**: Well, here we are! The following is meant to introduce you to what comes next and how you can use it.
## the site
You are here! For now, we can use `culturebridge.ga` as the website. But no worries, it would be as simple as 1 … 2 … and 3 to change it.
{{< expand "question" >}}
Have we considered `culturebridgetulsa.org`?
Though maybe the shorter `culturebridge` is better `¯\_(ツ)_/¯`.
We could also use `culturebridgetulsa.com` if we wanted to replace our other site.
{{< /expand >}}
### The Layout
{{< tabs "uniqueid" >}}
{{< tab "Mobile" >}}
## Mobile Layout
There are two "menus" you have to know about. First, the actual menu. This is the three bars in the top left. Click on it and you will see a big "CultureBridge Tulsa", a search input, and a Table of Contents. The search function is still a work-in-progress, so it may or may not work.
The table of contents you see here is site-wide. It links to all of the major pages. Think of these as chapters in a book.
{{< hint info >}}
**Did you know?** The theme of our site is actually called "Hugo Book". How appropriate!
{{< /hint >}}
You should see the Modules section, the Supplements section, and an Info section. These will be the major parts of the site. One day you will be able to click on "Modules" and see a page explaining what the modules are and linking to all of them. Or, you could jump right in and go to the Module you want (go ahead! try looking at the Debrief or Intro).
The same thing will happen with the Supplements and the Info section.
{{< expand "What is the Info section?" >}}
The Info section is the miscellaneous items we talked about going into the Wiki. Examples include the YPI page, the New Tulsans page, a history & timeline of our experience in CultureBridge, and more! We can pretty much add whatever we want.
{{< /expand >}}
There is
{{< /tab >}}
{{< tab "Desktop" >}}
## Desktop Layout
For everyone reading this on a computer, I might as well come out and say it: **I love you**.
Why? Because the web is just so much better on a big screen. Why do we limit ourselves to tiny little things which make life **so much harder** for programmers and designers?
So, I'm not going to waste your time here. On a computer it's much easier to see the Menu and the single-page Table of Contents. Everything is pretty intuitive. But if you're curious, go ahead and switch over to the "Mobile" tab to read about it all.
Love you,
Nate
{{< /tab >}}
{{< /tabs >}}
## Netlify CMS
I'm jumping ahead to this section cause it's the most necessary. The [Markdown](#markdown) section is also somethat important, if you want to be cool, but it's not strictly necessary, as you will see in this section.
**What is Netlify CMS?**
A CMS is a "Content Management System". In other words, it's a system which helps us manage our content. Or, in even different other words, it's a thing we will use to write, edit, style, and "push" each page on the site.
{{< hint info >}}
"Push" here means to send the content to our backend system which will automatically add it to the website. To know what it actually means, in a technical sense, read the rest of this Documentation (yes, I am trying to convert you all into technically literate people). The best way to learn tech is to read, to practice, to randomly explore, and [to hack](https://ijams.tk/posts/rules/#hacker).
{{< /hint >}}
In summary, these are the instructions for how you will make content on this site.
### Making your account
Whoa! An account! Get excited everyone, this is where it gets fun. It's also where you need to be using a computer, not a phone :)
First, go to [culturebridge.ga/admin/](https://culturebridge.ga/admin/).
## Markdown
## Netlify (not the CMS)
## Hugo
## git
---
title: "Info"
weight: 30
bookFlatSection: false
bookToc: true
bookHidden: false
bookCollapseSection: false
bookComments: true
---
# Information
This section will tell you all about us, the background to our project, our partners, and more!
---
title: "New Tulsans Initiative"
weight: 1
bookFlatSection: false
bookToc: true
bookHidden: false
bookCollapseSection: false
bookComments: true
---
---
title: "Youth Philanthropy Initiative"
weight: 1
bookFlatSection: false
bookToc: false
bookHidden: false
bookCollapseSection: false
bookComments: true
---
# Youth Philanthropy Initiative
| **Name** | Youth Philanthropy Initiative |
| --- | --- |
| **Website** | <https://ypitulsa.org> |
| **Funding** | Charles and Lynn Schustermann Family Foundation |
| **Founded** | 2007 |
[Youth Philanthropy
Initiative](https://ypitulsa.org) equips teens with
the necessary tools and understanding to become social entrepreneurs.
Teens in YPI are socially and culturally aware, building their projects
around issues or problems they believe are pertinent in the Tulsa
community. All YPI projects are built to be sustainable through
research, organization, and long-term planning, giving students hands-on
experiences to use in college and beyond. YPI students are involved in
leadership, athletics, speech and debate, art, programming, but they all
come together with the same passion to make tangible change in their
communities.
{"Target":"book.min.cf645c91034b34b2924e585c8f8373b84f59b2640cfbb9040f3ddca20bf7b443.css","MediaType":"text/css","Data":{"Integrity":"sha256-z2RckQNLNLKSTlhcj4NzuE9ZsmQM+7kEDz3cogv3tEM="}}
\ No newline at end of file
{"Target":"book.min.44169960fa7e41d93cd844b3b58429da5e651f69acd8491a44b3dd94663c6930.css","MediaType":"text/css","Data":{"Integrity":"sha256-RBaZYPp+Qdk82ESztYQp2l5lH2ms2EkaRLPdlGY8aTA="}}
\ No newline at end of file
......@@ -49,14 +49,3 @@ collections:
- {label: "Hidden", name: "bookHidden", widget: "boolean"}
- {label: "Collapse Section", name: "bookCollapseSection", widget: "boolean"}
- {label: "Weight", name: "weight", widget: "number"}
- name: "home" # Used in routes, e.g., /admin/collections/blog
label: "Home Page" # Used in the UI
file: "content/_index.md" # The path to the folder where the documents are stored
fields: # The fields for each document, usually in front matter
- {label: "Title", name: "title", widget: "string"}
- {label: "Body", name: "body", widget: "markdown"}
- {label: "Flatten Section in TOC", name: "bookFlatSection", widget: "boolean"}
- {label: "Table of Contents", name: "bookToc", widget: "boolean"}
- {label: "Hidden", name: "bookHidden", widget: "boolean"}
- {label: "Collapse Section", name: "bookCollapseSection", widget: "boolean"}
- {label: "Weight", name: "weight", widget: "number"}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment