Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support subcategories, reorganise Engineering Handbook #408

Merged
merged 2 commits into from
Apr 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ GEM
mercenary (0.4.0)
nokogiri (1.12.5-arm64-darwin)
racc (~> 1.4)
nokogiri (1.12.5-x86_64-darwin)
racc (~> 1.4)
parallel (1.22.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
Expand Down Expand Up @@ -105,6 +107,7 @@ PLATFORMS
arm64-darwin-20
arm64-darwin-21
arm64-darwin-22
x86_64-darwin-22

DEPENDENCIES
html-proofer (~> 3.19)
Expand Down
50 changes: 42 additions & 8 deletions _layouts/page.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
<!-- TODO: The menu doesn't allow for subdirectories yet. See: https://bulma.io/documentation/components/menu/ -->
<!DOCTYPE html>
<html>

Expand All @@ -21,19 +20,54 @@
{% else %}
<span class="icon"><i class="fas fa-book-open"></i></span>
{% endif %}

{{ collection.name | capitalize }}
</p>
<ul class="menu-list">

<!-- render pages without 'subcategory' front matter -->
{% assign items = site[collection.label] | sort: "weight" %}
{% for item in items %}
<li>
<a href="{{ item.url }}" class="{% if item.url == page.url %}is-active{% endif %}">
{{ item.title }}
</a>
</li>
{% unless item.subcategory %}
<li><a href="{{ item.url }}" class="{% if item.url == page.url %}is-active{% endif %}">{{ item.title }}</a></li>
{% endunless %}
{% endfor %}
</ul>

<!-- render pages with 'subcategory' front matter -->
{% assign subcategories = site[collection.label] | map: "subcategory" | uniq | compact %}
{% assign num_subcategories = subcategories | size %}
{% if num_subcategories > 0 %}
{% for subcategory in subcategories %}
{% assign items = site[collection.label] | sort: "weight" | where: "subcategory", subcategory %}

<!-- try to find an item in this subcategory called 'index' to use as header link -->
{% assign index_url = "#" %}
{% for item in items %}
{% assign page_name = item.url | split:"/" | last %}
{% if page_name == "index" %}
{% assign index_url = item.url %}
{% endif %}
{% endfor %}

<li>
<a href="{{ index_url }}">
<span class="icon"><i class="fa-regular fa-folder-open"></i></span>
{{ subcategory }}
</a>
<ul>
{% for item in items %}
{% unless item.url == index_url %}
<li>
<a href="{{ item.url }}" class="{% if item.url == page.url %}is-active{% endif %}">{{ item.title }}</a>
</li>
{% endunless %}
{% endfor %}
</ul>
</li>

{% endfor %%}
{% endif %}

</ul>
{% endif %}
{% endfor %}
{% endif %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: page
title: Dev Standards
weight: 3
weight: 1
subcategory: Dev Standards
---

This page is a resource for development standards across all Meltano products and Meltano code repos.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: page
title: Pull Request (PR) Process
weight: 2
subcategory: Dev Standards
---

## Trivial Updates
Expand All @@ -11,7 +12,7 @@ A pull request that touches code is never trivial, but one that fixes a typo in

Trivial updates, such as docs updates, do not require a logged issue.

Outside of very trivial issues like typo's, if a PR is opened *without* an associated issue, the PR description should then briefly explain why the PR is needed or what led to its creation.
Outside of very trivial issues like typo's, if a PR is opened _without_ an associated issue, the PR description should then briefly explain why the PR is needed or what led to its creation.

## PR Review Process

Expand Down Expand Up @@ -61,8 +62,7 @@ Occasionally we need to help a contributor get their PR completed by contributin

#### Step 1: Author must allow edits from maintainers

According to the [docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork
):
According to the [docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork):

> Only pull request authors can give upstream repository maintainers, or those with push access to the upstream repository, permission to make commits to their pull request's compare branch in a user-owned fork.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: page
title: Stable Increments
weight: 3
subcategory: Dev Standards
---

This page describes stable vs unstable increments, and is primarily focused on Engineering use cases and applications.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: page
title: Team Practices
weight: 2
weight: 1
subcategory: Team Practices
---

This page defines recurring practices which help the Engineering team to function effectively and efficiently.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: page
title: Outages and Escalation
weight: 3
subcategory: Team Practices
---

## Types of escalations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: page
title: Release Process
weight: 2
subcategory: Team Practices
---

The process below applies to both Meltano and then SDK, unless otherwise noted.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: page
title: Handling of Sensitive Data
weight: 12
weight: 3
subcategory: Team Practices
---

## Data Classifications
Expand Down