Skip to content

Commit 6111eec

Browse files
authored
Merge pull request cds-hooks#381 from buildpacks/feature/contrib-tabs
Make different type of contributions use tabs
2 parents c5fd081 + 0e5146d commit 6111eec

File tree

5 files changed

+134
-32
lines changed

5 files changed

+134
-32
lines changed

content/community.md

Lines changed: 50 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,53 +5,74 @@ layout="community"
55
summary="Join other users, contributors and providers of Cloud Native Buildpacks."
66
+++
77

8-
## What type of contributions can I make?
8+
## Calendar
99

10-
Buildpacks welcomes all types of contributions, not just those related to code. We value any help that you can provide, and are more than happy to guide you through the process.
10+
Partake in one or many of our following public events:
1111

12-
#### Documentation
12+
{{< calendar >}}
1313

14-
This involves documenting any aspect of the project. We have various open issues for you to start off with. Another good starting point would revolve around your comprehension or desired area of expertise.
14+
## Contributing
1515

16-
Some examples where we'd value documentation contributions are:
17-
- Providing additional tutorials/guides to our [docs site](https://buildpacks.io/)
18-
- Adding additional information or examples to our [samples repo](https://github.com/buildpacks/samples)
19-
- Working on open issues, such as on our
20-
- [Documentation repo](https://github.com/buildpacks/docs/issues)
21-
- [Samples repo](https://github.com/buildpacks/samples/issues)
22-
- Adding GoDocs to codebases, such as
23-
- [libcnb](https://github.com/buildpacks/libcnb)
24-
- [lifecycle](https://github.com/buildpacks/lifecycle)
25-
- [pack](https://github.com/buildpacks/pack)
26-
- Writing posts for our [Medium blog](https://medium.com/buildpacks). Please discuss blog proposals with the [learning team on Slack](https://buildpacks.slack.com/archives/CST4A3ECV).
16+
#### What type of contributions can I make?
2717

28-
If you have any other ideas where documentation would be useful, please feel free to open up an issue in the related repository, or drop a message at the [#docs channel on Slack!](https://buildpacks.slack.com/archives/CDLN5A3TL)
18+
Buildpacks welcomes all types of contributions, not just those related to code. We value any help that you can provide, and are more than happy to guide you through the process.
19+
20+
{{< tabs active="Code">}}
2921

30-
#### Code
22+
{{< tab name="Code" >}}
3123

32-
Code contributions are always welcome to any Buildpacks repository.
24+
Code contributions are always welcome to any Buildpacks repository.
3325

3426
The following repositories are good starting points for code contributions:
27+
3528
- [libcnb](https://github.com/buildpacks/libcnb)
3629
- [lifecycle](https://github.com/buildpacks/lifecycle)
3730
- [pack](https://github.com/buildpacks/pack)
3831

3932
Other, more specialized, repositories include:
33+
4034
- [tekton-integration](https://github.com/buildpacks/tekton-integration)
4135
- [pack-orb](https://github.com/buildpacks/pack-orb)
4236

43-
#### RFCs
37+
{{< /tab >}}
38+
39+
{{< tab name="Documentation" >}}
40+
41+
This involves documenting any aspect of the project. We have various open issues for you to start off with. Another good starting point would revolve around your comprehension or desired area of expertise.
42+
43+
Some examples where we'd value documentation contributions are:
44+
45+
- Providing additional tutorials/guides to our [docs site](https://buildpacks.io/)
46+
- Adding additional information or examples to our [samples repo](https://github.com/buildpacks/samples)
47+
- Working on open issues, such as on our
48+
- [Documentation repo](https://github.com/buildpacks/docs/issues)
49+
- [Samples repo](https://github.com/buildpacks/samples/issues)
50+
- Adding GoDocs to codebases, such as
51+
- [libcnb](https://github.com/buildpacks/libcnb)
52+
- [lifecycle](https://github.com/buildpacks/lifecycle)
53+
- [pack](https://github.com/buildpacks/pack)
54+
- Writing posts for our [Medium blog](https://medium.com/buildpacks). Please discuss blog proposals with the [learning team on Slack](https://buildpacks.slack.com/archives/CST4A3ECV).
55+
56+
If you have any other ideas where documentation would be useful, please feel free to open up an issue in the related repository, or drop a message at the [#docs channel on Slack!](https://buildpacks.slack.com/archives/CDLN5A3TL)
57+
58+
{{< /tab >}}
59+
60+
{{< tab name="RFCs" >}}
4461

4562
RFCs, or Request For Comments, is the process we employ to review project-wide changes. By proposing changes via RFCs, it allows for the entire community to partake in the brainstorming process of applying changes, considering alternatives, impact, and limitations.
4663

4764
Contributions to the RFC process can take any or all of the following forms:
65+
4866
- Reviewing and commenting on [RFC Pull Requests](https://github.com/buildpacks/rfcs/pulls)
4967
- Partaking in discussions in [Working Group](https://github.com/buildpacks/community/#working-group) meetings
5068
- Proposing changes via [RFCs](https://github.com/buildpacks/rfcs)
5169

52-
#### Triage
70+
{{< /tab >}}
71+
72+
{{< tab name="Triage" >}}
5373

5474
Triaging issues is the process of looking at newly created issues (or following up on issues). There are many benefits our community gains from our current triage process, such as:
75+
5576
- The community receives reasonable response times.
5677
- Minimize the number of open "stale" issues.
5778
- Ongoing efforts aren't disrupted.
@@ -60,30 +81,30 @@ To learn more about how you can help triage issues, check out our dedicated [tri
6081

6182
If you're looking at open issues but unsure where to start, try looking for issues with the "good first issue" or "help wanted" labels!
6283

63-
## How do I submit a pull request?
84+
{{< /tab >}}
85+
86+
{{< /tabs >}}
87+
88+
#### How do I submit a pull request?
6489

6590
If your contribution requires changes to a project repository, look at the DEVELOPMENT.md file if the repo has one to ensure you have the prerequisites installed. It may also include other necessary steps (such as instructions on running tests), but broadly, you will have to carry out the following steps:
91+
6692
- [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository.
6793
- [Clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) your fork repository.
6894
- Create a branch for the issue: `git checkout -b {{BRANCH_NAME}}`
6995
- Make any changes deemed necessary.
7096
- Commit your changes with a sign-off: `git commit -s`
7197

7298
A sign-off is a single line added to your commit messages that certifies that you wrote and/or have the right to the contributed changes. The signature should look as such:
99+
73100
```
74101
Signed-off-by: John Doe <[email protected]>
75102
```
103+
76104
Also, git can automatically add the signature by adding the -s flag to the commit command,
77105
`git commit -s`
78106

79-
The full text of the certification is available [here](https://developercertificate.org/).
107+
The full text of the certification is available [here](https://developercertificate.org/).
80108

81109
- Push to GitHub: `git push origin {{BRANCH_NAME}}`
82110
- [Create the pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
83-
84-
85-
## Calendar
86-
87-
Partake in one or many of our following public events:
88-
89-
{{< calendar >}}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{{ $name := .Get "name" }}
2+
{{ $id := $name | urlize }}
3+
{{ $active := cond (eq (.Parent.Get "active" | urlize) $id) "active" "" }}
4+
<div
5+
class="tab-pane fade {{$active}}"
6+
id="tab-content-{{$id}}"
7+
role="tabpanel"
8+
data-tab-name="{{$name}}"
9+
aria-labelledby="tab-{{$id}}"
10+
>
11+
{{ .Inner | markdownify }}
12+
</div>
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!-- Nav tabs -->
2+
<div class="tabbable">
3+
<ul class="nav nav-tabs m-0" role="tablist">
4+
{{ $activeID := .Get "active" | urlize }}
5+
{{ range findRE "data-tab-name=\"([^\"]+)" .Inner }}
6+
{{ $name := replaceRE "data-tab-name=\"([^\"]+)" "$1" . }}
7+
{{ $id := $name | urlize }}
8+
{{ $active := cond (eq $activeID $id) "active in show" "" }}
9+
{{ $selected := cond (eq $activeID $id) "true" "false" }}
10+
<li class="nav-item" role="presentation">
11+
<a class="nav-link {{$active}}" id="tab-{{$id}}" data-toggle="tab" href="#tab-content-{{$id}}" role="tab"
12+
aria-controls="tab-content-{{$id}}" aria-selected="{{$selected}}">
13+
{{- $name -}}
14+
</a>
15+
</li>
16+
{{ end }}
17+
</ul>
18+
19+
<!-- Tab panes -->
20+
<div class="tab-content p-3 bg-off-blue">
21+
{{ .Inner | markdownify }}
22+
</div>
23+
</div>
24+
25+
<script type="application/javascript">
26+
$("ul.nav-tabs a").click(function (e) {
27+
e.preventDefault();
28+
$(this).tab('show');
29+
});
30+
</script>

tools/go.mod

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,27 @@ module github.com/buildpacks/docs/tools
33
go 1.14
44

55
require (
6-
github.com/buildpacks/imgutil v0.0.0-20210323214708-5a2568dd25b6 // indirect
7-
github.com/buildpacks/pack v0.18.1
6+
github.com/Azure/azure-sdk-for-go v42.3.0+incompatible // indirect
7+
github.com/buildpacks/pack v0.19.0
88
github.com/containerd/containerd v1.5.0-beta.4 // indirect
99
github.com/containerd/stargz-snapshotter/estargz v0.5.0 // indirect
1010
github.com/docker/cli v20.10.5+incompatible // indirect
1111
github.com/docker/docker v20.10.5+incompatible // indirect
1212
github.com/gohugoio/hugo v0.82.0
13+
github.com/hashicorp/golang-lru v0.5.3 // indirect
14+
github.com/jromero/ugo v0.0.0-20200909162226-1fa70f1e3823 // indirect
1315
github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351 // indirect
1416
github.com/moby/term v0.0.0-20201216013528-df9cb8a40635 // indirect
1517
github.com/sabhiram/go-gitignore v0.0.0-20201211210132-54b8a0bf510f // indirect
1618
github.com/sirupsen/logrus v1.8.1 // indirect
1719
github.com/spf13/cobra v1.1.3
20+
github.com/vdemeester/k8s-pkg-credentialprovider v1.18.1-0.20201019120933-f1d16962a4db // indirect
1821
golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2 // indirect
19-
golang.org/x/net v0.0.0-20210326060303-6b1517762897 // indirect
2022
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c // indirect
2123
golang.org/x/term v0.0.0-20210317153231-de623e64d2a6 // indirect
24+
gonum.org/v1/netlib v0.0.0-20190331212654-76723241ea4e // indirect
2225
google.golang.org/genproto v0.0.0-20210325224202-eed09b1b5210 // indirect
2326
google.golang.org/grpc v1.36.1 // indirect
27+
k8s.io/code-generator v0.20.1 // indirect
28+
sigs.k8s.io/structured-merge-diff v0.0.0-20190525122527-15d366b2352e // indirect
2429
)

0 commit comments

Comments
 (0)