Skip to content

Commit

Permalink
Update documentation with correct Git commands
Browse files Browse the repository at this point in the history
The documentation has been updated to replace incorrect references of 'playbooks-repository' with the correct 'git' command. Additionally, an icon source in the main site page was replaced to better reflect the compatibility with Ansible. These changes ensure that users are provided with accurate instructions and consistent visual cues.
  • Loading branch information
manu committed Jun 30, 2024
1 parent 4d6f063 commit 576ec80
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion site/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ cd SquirrelCorporation
git checkout master

# Pull the latest updates
playbooks-repository pull
git pull

# Create a new branch for your changes
playbooks-repository checkout -b <YOUR-BRANCH-NAME>
Expand Down
6 changes: 3 additions & 3 deletions site/contribute/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Before initiating a new release, ensure you have pulled the latest changes from

```sh
# Pull the latest changes from the remote repository
playbooks-repository pull origin master
git pull origin master

# Run your tests to ensure everything works as expected
npm test
Expand All @@ -21,11 +21,11 @@ Once your master branch is up to date and tests are passing, create a new Git ta
```sh
# The format is v<MAJOR>.<MINOR>.<PATCH>
# For example:
playbooks-repository tag v1.0.0
git tag v1.0.0
```

After creating the new tag, it needs to be pushed to the GitHub repository.

```sh
playbooks-repository push origin v1.0.0
git push origin v1.0.0
```
2 changes: 1 addition & 1 deletion site/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Docker will create a volume directory *.data.prod* in the directory for persiste
In SSM cloned directory:

```shell
playbooks-repository pull
git pull
```

```shell
Expand Down
2 changes: 1 addition & 1 deletion site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ features:
- title: Ansible & Docker Compatible
details: Thanks to the power of Ansible and Docker, you can totally manage your servers, services and configuration from SSM
icon:
src: /playbooks.svg
src: /ansible.svg
- title: Simple to use, yet powerful
details: Even is SSM is focused on easiness of use, it flexibility enables you to make powerful and complex setups
icon:
Expand Down

0 comments on commit 576ec80

Please sign in to comment.