diff --git a/ADD_ANNOUNCEMENT.md b/ADD_ANNOUNCEMENT.md index 28f5b84d4..c6f4ce73b 100644 --- a/ADD_ANNOUNCEMENT.md +++ b/ADD_ANNOUNCEMENT.md @@ -1,7 +1,7 @@ # How to add announcement Please follow these steps to add announcement 1. Fork [Falco](https://github.com/falcosecurity/falco-website) repository -2. Add new announcemnt to [data/en/announcements](https://github.com/falcosecurity/falco-website/tree/master/data/en/announcements) in a following format: +2. Add new announcemnt to [data/en/announcements](https://github.com/falcosecurity/falco-website/tree/main/data/en/announcements) in a following format: ``` index: 2 startDate: '2023-04-01T00:00:00-0700' diff --git a/ADD_BLOG.md b/ADD_BLOG.md index a61d82f77..3d149e63a 100644 --- a/ADD_BLOG.md +++ b/ADD_BLOG.md @@ -1,11 +1,11 @@ Please follow these steps to add your blog to [Falco blog folder](https://falco.org/blog/): 1. Fork the [Falco](https://github.com/falcosecurity/falco-website) repository. 2. Clone the repository locally or work directly on GitHub. -3. In the path [`falco-website/content/en/blog/`](https://github.com/falcosecurity/falco-website/tree/master/content/en/blog) create a directory to contain your [Markdown](https://www.markdownguide.org/cheat-sheet/) `index.md` file and a subdirectory called `images/`. +3. In the path [`falco-website/content/en/blog/`](https://github.com/falcosecurity/falco-website/tree/main/content/en/blog) create a directory to contain your [Markdown](https://www.markdownguide.org/cheat-sheet/) `index.md` file and a subdirectory called `images/`. - The directory name should **not** contain any space. For better readability, _kebab-case_ is recommended (lowercase words separated by dashes). - It is recommended to match the directory name to the [slug](https://en.wikipedia.org/wiki/Clean_URL#Slug) of the blog post. - Keep it short but informative. - - [Example on GitHub](https://github.com/falcosecurity/falco-website/tree/master/content/en/blog/gitops-your-falco-rules): + - [Example on GitHub](https://github.com/falcosecurity/falco-website/tree/main/content/en/blog/gitops-your-falco-rules): ``` falco-website/content/en/blog/gitops-your-falco-rules/ falco-website/content/en/blog/gitops-your-falco-rules/index.md diff --git a/ADD_KEYWORDS.md b/ADD_KEYWORDS.md index bb0a8031c..05b9b0c2b 100644 --- a/ADD_KEYWORDS.md +++ b/ADD_KEYWORDS.md @@ -1,7 +1,7 @@ # 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 +2. Choose any markdown file in [content folder](https://github.com/falcosecurity/falco-website/tree/main/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. ``` --- diff --git a/README.md b/README.md index a244dfe53..9958b48f1 100755 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ In order to contribute a logo you must meet one of the following adopter types. Then open a pull request to this repository that contains: - - A `.png` or `.svg` file in [clients](https://github.com/falcosecurity/falco-website/tree/master/static/img/adopters) + - A `.png` or `.svg` file in [clients](https://github.com/falcosecurity/falco-website/tree/main/static/img/adopters) - A change to [params.toml](https://github.com/falcosecurity/falco-website/blob/master/config/_default/params.toml) that includes your logo alphabetically. Detailed instructions to add new adopters or training providers are included into the specified Hugo config file. - Links and references to demonstrate you meet the criteria above. diff --git a/content/en/blog/falco-i18n.md b/content/en/blog/falco-i18n.md index 06696f1e7..e652485c9 100644 --- a/content/en/blog/falco-i18n.md +++ b/content/en/blog/falco-i18n.md @@ -23,8 +23,8 @@ For example, when left as a comment on an issue or PR, the command `/kind transl The files and directories associated with the Falco localization are: -* The [i18n](https://github.com/falcosecurity/falco-website/tree/master/i18n) directory: It contains the translated homepage of the Falco website. Each locale will have a file corresponding to the homepage. You should create one corresponding to your language. -* The [content](https://github.com/falcosecurity/falco-website/tree/master/content) directory: The translated content for blog, documentation, community, and videos resides in the [content](https://github.com/falcosecurity/falco-website/tree/master/content) directory. +* The [i18n](https://github.com/falcosecurity/falco-website/tree/main/i18n) directory: It contains the translated homepage of the Falco website. Each locale will have a file corresponding to the homepage. You should create one corresponding to your language. +* The [content](https://github.com/falcosecurity/falco-website/tree/main/content) directory: The translated content for blog, documentation, community, and videos resides in the [content](https://github.com/falcosecurity/falco-website/tree/main/content) directory. * The [configuration file](https://github.com/falcosecurity/falco-website/blob/master/config.toml): It is located in the root directory. The TOML file contains the configuration of the static website generator, hugo. It contains settings for the languages, formatting, caches, and so on. Make sure that you create a language sub-section corresponding to your language. * OWNERS file: There is an [OWNERS](https://github.com/falcosecurity/falco-website/blob/master/OWNERS) file for the Falco website, listing the reviewers and approvers of the project. Similarly, create an OWNERS file for your language project. See the [OWNERS](https://github.com/falcosecurity/falco-website/blob/master/content/ml/OWNERS) file for Malayalam for reference. @@ -44,7 +44,7 @@ This section helps you start an i18n effort for Falco from scratch. Replace `language-` with your language of choice and locale code. -3. Create the `.yaml` file in the [i18n](https://github.com/falcosecurity/falco-website/tree/master/i18n) directory. +3. Create the `.yaml` file in the [i18n](https://github.com/falcosecurity/falco-website/tree/main/i18n) directory. In this file, you mainly include the translated content of the home page. @@ -66,7 +66,7 @@ This section helps you start an i18n effort for Falco from scratch. ``` -5. Create a directory, named ``, corresponding to your language in the [content](https://github.com/falcosecurity/falco-website/tree/master/content) directory. +5. Create a directory, named ``, corresponding to your language in the [content](https://github.com/falcosecurity/falco-website/tree/main/content) directory. For example, `content/ml` is the directory corresponding to the language, Malayalam. @@ -90,7 +90,7 @@ This section helps you start an i18n effort for Falco from scratch. 11. Translate the content in the Getting Started directory to your language. - For example, see the [English](https://github.com/falcosecurity/falco-website/tree/master/content/en/docs/getting-started) version of the Getting Started directory. + For example, see the [English](https://github.com/falcosecurity/falco-website/tree/main/content/en/docs/getting-started) version of the Getting Started directory. 12. Ensure that you sign your commit with `git commit -s -m "message”`. diff --git a/data/en/slideTemplates.yaml b/data/en/slideTemplates.yaml index 299a71d49..8040520ba 100644 --- a/data/en/slideTemplates.yaml +++ b/data/en/slideTemplates.yaml @@ -14,7 +14,7 @@ item: 1 VIDEO lastModified: Mar 20, 2023 - name: Diagrams developed in SVG and PNG - link: https://github.com/falcosecurity/falco-website/tree/master/static/img + link: https://github.com/falcosecurity/falco-website/tree/main/static/img img: /icons/diagram-fill.svg item: 10 diagrames lastModified: Mar 20, 2023 diff --git a/release.md b/release.md index 8561b8c02..10c97a453 100644 --- a/release.md +++ b/release.md @@ -1,7 +1,7 @@ # Falco Website Release Process -The release process of the [falco.org](https://falco.org) is automated by using [netlify](https://www.netlify.com/). Each commit merged into the `master` branch will be automatically deployed to [falco.org](https://falco.org). +The release process of the [falco.org](https://falco.org) is automated by using [netlify](https://www.netlify.com/). Each commit merged into the `main` branch will be automatically deployed to [falco.org](https://falco.org). > You can find the last deploy status by clicking on this [![Netlify Status](https://api.netlify.com/api/v1/badges/3ff1ba0c-68c8-4f94-b8fa-6260c6ae1925/deploy-status)](https://app.netlify.com/sites/falcosecurity/deploys) badge. @@ -21,7 +21,7 @@ Finally, once a snapshot for the previous version has been created, you need to The following instructions assume **`v0.x.y` is the version to be archived**. -1. Create the new `v0.x` branch from the current `master` branch. +1. Create the new `v0.x` branch from the current `main` branch. 2. Configure [the branch deploy control on Netlify](https://docs.netlify.com/site-deploys/overview/#branch-deploy-controls) by adding the newly created branch `v0.x`. 3. Within the `v0.x` branch, edit the [versions/params.yaml](config/_default/versions/params.yaml) file: - Set `archived_version` to `true`, @@ -43,7 +43,7 @@ The following instructions assume **`v0.x.y` is the version to be archived**. ```yaml falco-website: branches: - master: + main: protect: true v0.26: protect: true @@ -58,14 +58,14 @@ The following instructions assume **`v0.x.y` is the version to be archived**. > The following instructions assume **`v0.X.Y` is the new version** and **v0.x.y** is the previous already-archived version. -1. [Open a PR in the falcosecurity/falco-website repo](https://github.com/falcosecurity/falco-website/edit/master/config/_default/versions/params.yaml) to modify the [versions/params.yaml](config/_default/versions/params.yaml) file on the `master` branch: +1. [Open a PR in the falcosecurity/falco-website repo](https://github.com/falcosecurity/falco-website/edit/main/config/_default/versions/params.yaml) to modify the [versions/params.yaml](config/_default/versions/params.yaml) file on the `main` branch: - Make sure the `version` field is set to `v0.X.Y` (i.e., *the new version*). - **Insert** the following config block for *the new version* as the first entry of the list, right after the `versions:` line. Make sure the indentation is right (it should align with the adyacent blocks) and tabs should be avoided. ```yaml - fullversion: v0.X.Y version: vX.Y - githubbranch: master - docsbranch: master + githubbranch: main + docsbranch: main url: https://falco.org/ ``` - Update the current second YAML block refering to `v0.x.y` (i.e., *the previous version*) as following: