Skip to content

Commit

Permalink
Added tekton specific placeholders
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelawyu authored and tekton-robot committed Jan 21, 2020
1 parent 0ce932b commit 6c2f917
Show file tree
Hide file tree
Showing 12 changed files with 181 additions and 221 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
resources/
public/
public/
package-lock.json
75 changes: 75 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of
experience, education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at
[email protected]. All complaints will be reviewed and
investigated and will result in a response that is deemed necessary and
appropriate to the circumstances. The project team is obligated to maintain
confidentiality with regard to the reporter of an incident. Further details of
specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
39 changes: 18 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
# How to Contribute
# Contributing to the Tekton website

We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.
Thanks for considering contributing to our project!

## Contributor License Agreement
**All contributors must comply with
[the code of conduct](./CODE-OF-CONDUCT.md).**

Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution;
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.
To get started developing, see our [DEVELOPMENT.md](./DEVELOPMENT.md).

You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.
- The [OWNERS](OWNERS) of this repo are the
[members of the Tekton governing board](https://github.com/tektoncd/community/blob/master/governance.md)
as well as folks from the Linux Foundation who contribute to this project.

## Code reviews
In [the community repo](https://github.com/tektoncd/community) you'll find info
on:

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.
- [Contacting other contributors](https://github.com/tektoncd/community/blob/master/contact.md)
- [Development standards](https://github.com/tektoncd/community/blob/master/standards.md)
including standards for
[commit messages](https://github.com/tektoncd/community/blob/master/standards.md#commit-messages)
- [Processes](https://github.com/tektoncd/community/blob/master/process.md) like
[reviews](https://github.com/tektoncd/community/blob/master/process.md#reviews)

## Community Guidelines

This project follows
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
You can find details on our automation infrastructure in
[the plumbing repo](https://github.com/tektoncd/plumbing).
30 changes: 30 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Developing the Tekton website

- [Setting up your dev environment](#setup)
- [Deploying changes](#deploying)

## Setup

Before working on website issues, be sure to have the following installed:

- [Yarn](https://yarnpkg.com/en/)
- [Hugo](https://gohugo.io/)

You can [use the `hugo` command](https://gohugo.io/getting-started/usage/)
to interact with the site locally and see the results
[before deploying](#deploying).

## Deploying

At the moment, deployments are done manually after a merge to master.
Eventually we plan to move to [netlify](https://www.netlify.com/) (once we
transfer ownership of the `tekton.dev` domain to the Linux Foundation),
which would provide us with gitops based automation.

- Currently we are hosting `tekton.dev` on [firebase](https://firebase.google.com/)
- The `firebase` project is called `tekton`
- [Members of the Tekton governing board](https://github.com/tektoncd/community/blob/master/governance.md)
and other Linux Foundation contributors have access to the firebase project

Instructions for deploying Hugo based sites to Firebase:
https://gohugo.io/hosting-and-deployment/hosting-on-firebase/
12 changes: 12 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
serve:
hugo server \
--buildDrafts \
--buildFuture \
--disableFastRender \
--ignoreCache

production-build:
hugo

preview-build:
hugo --baseURL $(DEPLOY_PRIME_URL)
9 changes: 9 additions & 0 deletions OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# The OWNERS file is used by prow to automatically merge approved PRs.

approvers:
- bobcatfish
- dlorenc
- vdemeester
- kimsterv
- abayer
- lucperkins
62 changes: 8 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,12 @@
# Docsy Example
# TektonCD Website

[Docsy](https://github.com/google/docsy) is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. This **Docsy Example Project** uses the Docsy theme, as well as providing a skeleton documentation structure for you to use. You can either copy this project and edit it with your own content, or use the theme in your projects like any other [Hugo theme](https://gohugo.io/themes/installing-and-using-themes/).
This repo contains the code behind [the Tekton org's](https://github.com/tektoncd)
website at [tekton.dev](https://tekton.dev).

This Docsy Example Project is hosted at [https://example.docsy.dev/](https://example.docsy.dev/).
For more information on the Tekton Project, see
[the community repo](https://github.com/tektoncd/community).

You can find detailed theme instructions in the Docsy user guide: https://docsy.dev/docs/
For more information on contributing to the website see:

This is not an officially supported Google product. This project is currently maintained.

## Cloning the Docsy Example Project

The following will give you a project that is set up and ready to use (don't forget to use `--recurse-submodules` or you won't pull down some of the code you need to generate a working site). The `hugo server` command builds and serves the site. If you just want to build the site, run `hugo` instead.

```bash
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
cd docsy-example
hugo server
```

The theme is included as a Git submodule:

```bash
▶ git submodule
a053131a4ebf6a59e4e8834a42368e248d98c01d themes/docsy (heads/master)
```

If you want to do SCSS edits and want to publish these, you need to install `PostCSS` (not needed for `hugo server`):

```bash
npm install
```

<!--### Cloning the Example from the Theme Project
```bash
git clone --recurse-submodules --depth 1 https://github.com/docsy.git
cd tech-doc-hugo-theme/exampleSite
HUGO_THEMESDIR="../.." hugo server
```
Note that the Hugo Theme Site requires the `exampleSite` to live in a subfolder of the theme itself. To avoid recursive duplication, the example site is added as a Git subtree:
```bash
git subtree add --prefix exampleSite https://github.com/google/docsy.git master --squash
```
To pull in changes, see `pull-deps.sh` script in the theme.-->

## Running the website locally

Once you've cloned the site repo, from the repo root folder, run:

```
hugo server
```
* [CONTRIBUTING.md](CONTRIBUTING.md)
* [DEVELOPMENT.md](DEVELOPMENT.md)
57 changes: 11 additions & 46 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
baseURL = "/"
title = "Goldydocs"
title = "Tekton"

enableRobotsTXT = true

Expand Down Expand Up @@ -53,25 +53,17 @@ id = "UA-00000000-0"

[languages]
[languages.en]
title = "Goldydocs"
description = "A Docsy example site"
title = "Tekton"
description = "Kubernetes-native CI/CD"
languageName ="English"
# Weight used for sorting.
weight = 1
[languages.no]
title = "Goldydocs"
description = "Docsy er operativsystem for skyen"
languageName ="Norsk"
contentDir = "content/no"
time_format_default = "02.01.2006"
time_format_blog = "02.01.2006"


# Everything below this are Site Params

[params]
copyright = "The Docsy Authors"
privacy_policy = "https://policies.google.com/privacy"
copyright = "The Tekton Project"
privacy_policy = "https://www.linuxfoundation.org/privacy/"

# First one is picked as the Twitter card image if not set on page.
# images = ["images/project-illustration.png"]
Expand All @@ -81,9 +73,7 @@ privacy_policy = "https://policies.google.com/privacy"
version_menu = "Releases"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/google/docsy-example"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/google/docsy"
github_repo = "https://github.com/tektoncd/"

# Specify a value here if your content directory is not in your repo's root directory
# github_subdir = ""
Expand Down Expand Up @@ -111,40 +101,15 @@ footer_about_disable = false
[params.ui.feedback]
enable = true
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
yes = 'Thanks! <a href="https://github.com/tektoncd/website/issues/new">Tell us how we can further improve</a>.'
no = 'Sorry about that. <a href="https://github.com/tektoncd/website/issues/new">Tell us how we can further improve</a>.'

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
[[params.links.user]]
name = "User mailing list"
url = "https://example.org/mail"
icon = "fa fa-envelope"
desc = "Discussion and help from your fellow users"
[[params.links.user]]
name ="Twitter"
url = "https://example.org/twitter"
icon = "fab fa-twitter"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name = "Stack Overflow"
url = "https://example.org/stack"
icon = "fab fa-stack-overflow"
desc = "Practical questions and curated answers"
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "GitHub"
url = "https://github.com/google/docsy"
url = "https://github.com/tektoncd"
icon = "fab fa-github"
desc = "Development takes place here!"
[[params.links.developer]]
name = "Slack"
url = "https://example.org/slack"
icon = "fab fa-slack"
desc = "Chat with other project developers"
[[params.links.developer]]
name = "Developer mailing list"
url = "https://example.org/mail"
icon = "fa fa-envelope"
desc = "Discuss development issues around the project"
desc = "GitHub organization for the Tekton project"


Loading

0 comments on commit 6c2f917

Please sign in to comment.