Skip to content

Doc/add note to readme #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cristiGuranIonos merged 2 commits into from
Jun 22, 2022
Merged

Doc/add note to readme #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dba8726
add note to init command
cristiGuranIonos Jun 22, 2022
a554a8d
add note to init command
cristiGuranIonos Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,9 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2

initialize a codex project in S3

❗ **Note**: Before running the command, make sure to create the new bucket in dcd manager. After you create the bucket, run : `codex config s3.bucket <bucket_name_here>`, so you point to the correct
location. Make sure the new bucket supports versioning in order to save older versions of the swagger files over time.

```
USAGE
$ codex init URL
Expand All @@ -202,8 +205,6 @@ EXAMPLE
$ codex init https://api.url/spec
```

❗ _Note_: make sure the new bucket supports versioning in order to save older versions of the swagger files over time.

_See code: [src/commands/init.ts](https://github.com/ionos-cloud/codex/blob/v5.0.1/src/commands/init.ts)_

## `codex lock`
Expand Down