From 74e8fefbf510ef665433927a1f1bc783614d0c49 Mon Sep 17 00:00:00 2001 From: Bulat Date: Thu, 23 Mar 2023 23:51:55 +0600 Subject: [PATCH] feat: add how to instructions Signed-off-by: Bulat Safiullin --- ADD_BLOG.md | 21 +++++++++++++++++++++ ADD_CASE_STUDY.md | 19 +++++++++++++++++++ ADD_ECOSYSTEM_LOGO.md | 14 ++++++++++++++ ADD_EVENT.md | 1 + ADD_KEYWORDS.md | 14 ++++++++++++++ ADD_LANDING_LOGO.md | 14 ++++++++++++++ ADD_TRAINING.md | 22 ++++++++++++++++++++++ content/en/about/ecosystem.md | 2 +- layouts/index.en.html | 2 +- layouts/partials/training-content.html | 2 +- 10 files changed, 108 insertions(+), 3 deletions(-) create mode 100644 ADD_BLOG.md create mode 100644 ADD_CASE_STUDY.md create mode 100644 ADD_ECOSYSTEM_LOGO.md create mode 100644 ADD_EVENT.md create mode 100644 ADD_KEYWORDS.md create mode 100644 ADD_LANDING_LOGO.md create mode 100644 ADD_TRAINING.md diff --git a/ADD_BLOG.md b/ADD_BLOG.md new file mode 100644 index 000000000..7a9b14780 --- /dev/null +++ b/ADD_BLOG.md @@ -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 diff --git a/ADD_CASE_STUDY.md b/ADD_CASE_STUDY.md new file mode 100644 index 000000000..994654b33 --- /dev/null +++ b/ADD_CASE_STUDY.md @@ -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 diff --git a/ADD_ECOSYSTEM_LOGO.md b/ADD_ECOSYSTEM_LOGO.md new file mode 100644 index 000000000..0286d4f23 --- /dev/null +++ b/ADD_ECOSYSTEM_LOGO.md @@ -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 diff --git a/ADD_EVENT.md b/ADD_EVENT.md new file mode 100644 index 000000000..5a782736c --- /dev/null +++ b/ADD_EVENT.md @@ -0,0 +1 @@ +# How to add new event diff --git a/ADD_KEYWORDS.md b/ADD_KEYWORDS.md new file mode 100644 index 000000000..bb0a8031c --- /dev/null +++ b/ADD_KEYWORDS.md @@ -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 diff --git a/ADD_LANDING_LOGO.md b/ADD_LANDING_LOGO.md new file mode 100644 index 000000000..605ef8869 --- /dev/null +++ b/ADD_LANDING_LOGO.md @@ -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 diff --git a/ADD_TRAINING.md b/ADD_TRAINING.md new file mode 100644 index 000000000..9d19a9632 --- /dev/null +++ b/ADD_TRAINING.md @@ -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 diff --git a/content/en/about/ecosystem.md b/content/en/about/ecosystem.md index d44ee057a..38759b525 100644 --- a/content/en/about/ecosystem.md +++ b/content/en/about/ecosystem.md @@ -79,7 +79,7 @@ title: Falco Ecosystem {{< /blocks/grid >}}
- Add your logo + Add your logo
{{< /tab >}} diff --git a/layouts/index.en.html b/layouts/index.en.html index 4519581bd..657cf2aa5 100644 --- a/layouts/index.en.html +++ b/layouts/index.en.html @@ -177,7 +177,7 @@

{{ T "home_falco_is_used_by" | markdownify }}

{{ end }}
- + {{ T "add_your_logo_btn" | markdownify }}
diff --git a/layouts/partials/training-content.html b/layouts/partials/training-content.html index 64b07bc66..73a69e4c7 100644 --- a/layouts/partials/training-content.html +++ b/layouts/partials/training-content.html @@ -60,7 +60,7 @@

Adding new training resources

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?

- Add new resources + Add new resources
Open a PR and add it here!