Skip to content

Commit 59efbf2

Browse files
authored
Update metadata format (#13)
1 parent 13f1ea8 commit 59efbf2

File tree

3 files changed

+56
-0
lines changed

3 files changed

+56
-0
lines changed

CONTRIBUTING.md

+27
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
1+
# Adding new experiments
2+
3+
1. Create a new folder in the root of the repository.
4+
2. Add your and your team GitHub handles into the [`CODEOWNERS`](./CODEOWNERS) file. See [documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-file-location). Please keep the list of folder sorted alphabetically.
5+
3. Create a `README.md` file in the root of your folder and add frontmatter metadata on top of it. Please keep `Your awesome project title` under 55-60 characters. There'll be linting ruled added automatically.
6+
7+
```
8+
---
9+
title: "Your awesome project title"
10+
language: python
11+
author: "Your Name"
12+
date: 2022-10-15
13+
14+
tags:
15+
- list
16+
- of
17+
- awesome
18+
- tags
19+
---
20+
21+
# Your awesome project title
22+
23+
... markdown documentation about your project. People will be reading it.
24+
```
25+
26+
4. Create a branch and push it to this repository either with a fork (if you're not added directly) and create a pull request. Reviewers will be automatically assigned.
27+
128
# Python projects
229

330
..

database-diagram-builder/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
---
2+
title: "UML diagram builder for specified Spark Databases"
3+
language: python
4+
author: "Alex Ott"
5+
date: 2022-10-15
6+
7+
tags:
8+
- spark
9+
- diagrams
10+
- uml
11+
- notebook
12+
- plantuml
13+
- script
14+
---
15+
116
## Generates UML diagram for specified Spark databases
217

318
Generates [PlantUML](https://plantuml.com/) diagram for all, or selected databases registered in Databricks/Spark. Generated UML diagram then could be converted into PDF/SVG/PNG or other formats using `plantuml` command-line tool.

ip_access_list_analyzer/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
---
2+
title: "Analyzer/fix tool for Databricks IP Access Lists"
3+
language: python
4+
author: "Alex Ott"
5+
date: 2022-10-15
6+
7+
tags:
8+
- workspaces
9+
- security
10+
- ip-access-lists
11+
- script
12+
- installable
13+
---
14+
115
# Analyzer/fix tool for Databricks IP Access Lists
216

317
This tool is used to perform analysis of the [Databricks IP Access Lists for Workspaces](https://docs.databricks.com/security/network/ip-access-list-workspace.html) to identify problems, like:

0 commit comments

Comments
 (0)