Skip to content

Commit ef55548

Browse files
authored
Merge pull request #462 from bdsoha/feature/update-readme
Use markdown `note` tag in `README.md`
2 parents 39e57a4 + 65013fb commit ef55548

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
`Safe-settings`– an app to manage policy-as-code and apply repository settings to repositories across an organization.
66

77
1. In `safe-settings` all the settings are stored centrally in an `admin` repo within the organization. This is important. Unlike [Settings Probot](https://github.com/probot/settings), the settings files cannot be in individual repositories.
8-
<br> :wave:`NOTE:` It is possible to overrride this behavior and specify a custom repo instead of the `admin` repo.
9-
This could be done by setting an `env` variable called `ADMIN_REPO`.
8+
> **Note** It is possible to overrride this behavior and specify a custom repo instead of the `admin` repo.<br>
9+
> This could be done by setting an `env` variable called `ADMIN_REPO`.
1010
1111
1. There are 3 levels at which the settings could be managed:
1212
1. Org-level settings are defined in `.github/settings.yml`
13-
<br> :wave:`NOTE:` It is possible to overrride this behavior and specify a different filename for the `settings` yml repo.
14-
This could be done by setting an `env` variable called `SETTINGS_FILE_PATH`.
13+
> **Note** It is possible to overrride this behavior and specify a different filename for the `settings` yml repo.<br>
14+
> This could be done by setting an `env` variable called `SETTINGS_FILE_PATH`.
1515
1616
1. `Suborg` level settings. A `suborg` is an arbitrary collection of repos belonging to projects, business units, or teams. The `suborg` settings reside in a yaml file for each `suborg` in the `.github/suborgs` folder.
1717
1. `Repo` level settings. They reside in a repo specific yaml in `.github/repos` folder
1818
1. It is recommended to break the settings into org-level, suborg-level, and repo-level units. This will allow different teams to define and manage policies for their specific projects or business units. With `CODEOWNERS`, this will allow different people to be responsible for approving changes in different projects.
1919

20-
:wave:`NOTE:` `Suborg` and `Repo` level settings directory structure cannot be customized.
20+
> **Note** `Suborg` and `Repo` level settings directory structure cannot be customized.
2121
22-
:wave:`NOTE:` The settings file must have a `.yml` extension only. `.yaml` extension is ignored, for now.
22+
> **Note** The settings file must have a `.yml` extension only. `.yaml` extension is ignored, for now.
2323
2424
## How it works
2525

@@ -45,7 +45,7 @@ To apply `safe-settings` __only__ to a specific list of repos, add them to the `
4545

4646
To ignore `safe-settings` for a specific list of repos, add them to the `restrictedRepos` section as `exclude` array.
4747

48-
**Note**: The `include` and `exclude` attributes support as well regular expressions.
48+
> **Note** The `include` and `exclude` attributes support as well regular expressions.
4949
5050
### Custom rules
5151

0 commit comments

Comments
 (0)