Skip to content

Commit

Permalink
feat: add how to instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Bulat Safiullin <bulat.safiullin@akvelon.com>
  • Loading branch information
bullet03 authored and poiana committed Apr 3, 2023
1 parent 670324e commit 74e8fef
Show file tree
Hide file tree
Showing 10 changed files with 108 additions and 3 deletions.
21 changes: 21 additions & 0 deletions ADD_BLOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# How to add new blog
Please follow these steps to add your blog to [Falco blog folder](https://falco.org/blog/):
1. Fork [Falco](https://github.com/falcosecurity/falco-website) repository
2. Add new folder to the blog with the same name as your article name, .e.g. [https://github.com/falcosecurity/falco-website/blob/master/content/en/blog/falco-0-34-0](https://github.com/falcosecurity/falco-website/blob/master/content/en/blog/falco-0-34-0)
3. Add folder called images there, e.g. [https://github.com/falcosecurity/falco-website/blob/master/content/en/blog/falco-0-34-0/images](https://github.com/falcosecurity/falco-website/tree/master/content/en/blog/falco-0-34-0/images)
4. Add related images to the images folder. In the header of the Markdown file (the front matter), set a featured image. The recommended size of the featured image is 1200 x 628 pixels
5. Add file called index.md with content of the article, e.g. [https://github.com/falcosecurity/falco-website/blob/master/content/en/blog/falco-0-34-0/index.md](https://github.com/falcosecurity/falco-website/blob/master/content/en/blog/falco-0-34-0/index.md)
6. Copy template below to the created file and replace next fields with your data
```
---
title: Article name
date: 2023-01-01
author: FirstName FirstLastName, SecondName SecondLastName, ...
slug: same name as your folder name, e.g. falco-0-34-0
images:
- /blog/article-folder/images/this-is-the-featured-image.png
tags: ["Falco", "Integration", ...] List of all tags is available in https://github.com/falcosecurity/falco-website/blob/master/data/en/blog_tags.yaml
---
Content of the article...
```
7. Create pull request to the Falco repository with your changes
19 changes: 19 additions & 0 deletions ADD_CASE_STUDY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# How to add new case study
Please follow these steps to add your case-study to [Falco endusers](https://falco.org/about/ecosystem/):
1. Fork [Falco](https://github.com/falcosecurity/falco-website) repository
2. Add your case-study image to
the [static/img](https://github.com/falcosecurity/falco-website/blob/master/static/img)
folder. Use svg, preferably horizontal format, e.g. your_case_study.svg
3. Add your author image to
the [static/img](https://github.com/falcosecurity/falco-website/blob/master/static/img)
folder. Use svg, preferably rounded image, e.g. author_name.svg
4. Add an entry at the end of [quotes file](https://github.com/falcosecurity/falco-website/blob/master/data/en/quotes.yaml) after the previous ones using the template below and replace next fields with your data
```
---
- text: description
logoUrl: /img/your_case_study.svg
authorImgUrl: /img/author_name.svg
authorName: Author Name
authorPosition: Author Position
```
5. Create pull request to the Falco repository with your changes
14 changes: 14 additions & 0 deletions ADD_ECOSYSTEM_LOGO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# How to add new logo
Please follow these steps to add your logo to [Falco ecosystem page](https://falco.org/about/ecosystem/):
1. Fork [Falco](https://github.com/falcosecurity/falco-website) repository
2. Add your logo to
the [static/img/adopters](https://github.com/falcosecurity/falco-website/blob/master/static/img/adopters)
folder. Use png, preferably horizontal format
3. Add file with logo name to the [logos folder](https://github.com/falcosecurity/falco-website/blob/master/data/adopters/vendors) e.g., logo.yaml
4. Copy template below to the created file and replace next fields with your data
```
src: your_logo_name.png
alt: alt tag decription
url: https://your_url.com/
```
5. Create pull request to the Falco repository with your changes
1 change: 1 addition & 0 deletions ADD_EVENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# How to add new event
14 changes: 14 additions & 0 deletions ADD_KEYWORDS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# How to add keywords
Please follow these steps to add keywords to any page on [Falco](https://falco.org/):
1. Fork [Falco](https://github.com/falcosecurity/falco-website) repository
2. Choose any markdown file in [content folder](https://github.com/falcosecurity/falco-website/tree/master/content), e.g. https://github.com/falcosecurity/falco-website/blob/master/content/en/blog/falco-0-34-0/index.md
3. In the header of the Markdown file (the front matter), set a field called `keywords` with your keywords separated by comma, e.g.
```
---
title: Falco 0.34.0 a.k.a. "The Honeybee 🍯"
date: 2023-02-07
...
keywords: keyword1, keyword2, keyword3
---
```
4. Create pull request to the Falco repository with your changes
14 changes: 14 additions & 0 deletions ADD_LANDING_LOGO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# How to add new logo
Please follow these steps to add your logo to [Falco landing page](https://falco.org/):
1. Fork [Falco](https://github.com/falcosecurity/falco-website) repository
2. Add your logo to
the [static/img/adopters](https://github.com/falcosecurity/falco-website/blob/master/static/img/adopters)
folder. Use png, preferably horizontal format
3. Add file with logo name to the [logos folder](https://github.com/falcosecurity/falco-website/blob/master/data/adopters/endusers) e.g., logo.yaml
4. Copy template below to the created file and replace next fields with your data
```
src: your_logo_name.png
alt: alt tag decription
url: https://your_url.com/
```
5. Create pull request to the Falco repository with your changes
22 changes: 22 additions & 0 deletions ADD_TRAINING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# How to add new training
Please follow these steps to add your training to [Falco trainings](https://falco.org/training/):
1. Fork [Falco](https://github.com/falcosecurity/falco-website) repository
2. Add your training image to
the [static/images/training/offerings](https://github.com/falcosecurity/falco-website/blob/master/static/images/training/offerings)
folder. Use svg, preferably horizontal format, e.g. your_training_name.svg
3. Add file with training name to [training/offerings folder](https://github.com/falcosecurity/falco-website/blob/master/data/training/offerings), e.g., training_name.yaml
4. Copy template below to the created file and replace next fields with your data
```
---
name: Training name
type: course
link: https://your_training_url.com/
description: Your training description
thumbnail: falco-plugins.svg
duration: 0 hr 00 min
provider: your_training_name.svg
name: sysdig
order: 4
...
```
5. Create pull request to the Falco repository with your changes
2 changes: 1 addition & 1 deletion content/en/about/ecosystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ title: Falco Ecosystem
{{< /blocks/grid >}}

<div class="text-center mt-4">
<a class="btn btn-lg btn-primary" href="https://github.com/falcosecurity/falco/blob/master/ADOPTERS.md#adding-a-name" role="button">Add your logo</a>
<a class="btn btn-lg btn-primary" href="https://github.com/falcosecurity/falco-website/blob/master/ADD_ECOSYSTEM_LOGO.md" role="button">Add your logo</a>
</div>

{{< /tab >}}
Expand Down
2 changes: 1 addition & 1 deletion layouts/index.en.html
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ <h3 class="">{{ T "home_falco_is_used_by" | markdownify }}</h3>
{{ end }}
</div>
<div class="mt-5 d-flex justify-content-center">
<a href="#" role="button" class="btn btn-primary px-4 py-2">
<a href="https://github.com/falcosecurity/falco-website/blob/master/ADD_LANDING_LOGO.md" role="button" class="btn btn-primary px-4 py-2">
{{ T "add_your_logo_btn" | markdownify }}
</a>
</div>
Expand Down
2 changes: 1 addition & 1 deletion layouts/partials/training-content.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ <h4>Adding new training resources</h4>
<p>Falco training is built and maintained by its community members.Have you created any material that might be useful for others to learn about Falco and Runtime Security?</p>
</div>
<div class="m-0 ml-md-5 mt-3 mt-md-0">
<a href="#" class="btn btn-primary px-4 py-2 text-nowrap">Add new resources</a>
<a href="https://github.com/falcosecurity/falco-website/blob/master/ADD_TRAINING.md" class="btn btn-primary px-4 py-2 text-nowrap">Add new resources</a>
<div class="font-weight-bold mt-3">Open a PR and add it here!</div>
</div>
</div>
Expand Down

0 comments on commit 74e8fef

Please sign in to comment.