Improve documentation #29
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MattiSG
approved these changes
Dec 13, 2023
README.md
Outdated
| @@ -112,7 +112,7 @@ Available variables are listed below, along with default values: | |||
| | --- | --- | --- | | |||
| | `ota_federated_api_repo` | Repository URL of the federated API code | `https://github.com/OpenTermsArchive/federated-api.git` | | |||
| | `ota_federated_api_directory` | Path of the directory where the code will be deployed on the server | `federated-api` | | |||
| | `ota_federated_api_branch` | Git branch of the federated API repository to use | `main` | | |||
| | `ota_federated_api_branch` | Git branch or tag of the federated API repository to use | `main` | | |||
There was a problem hiding this comment.
Suggested change
| | `ota_federated_api_branch` | Git branch or tag of the federated API repository to use | `main` | | |
| | `ota_federated_api_branch` | [Git tree-ish](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftree-ishatree-ishalsotreeish) (branch name, tag name…) of the federated API repository to use | `main` | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.