Skip to content

Commit

Permalink
doc: Update the guide on deploying dev site
Browse files Browse the repository at this point in the history
`docs/` should be removed from .gitignore before making a commit,
because otherwise the external links (e.g., plat-doc/islet_rmm)
will be inaccessible.

Signed-off-by: Changho Choi <ch754.choi@samsung.com>
  • Loading branch information
zpzigi754 committed Oct 16, 2024
1 parent 2dd75a1 commit 9338ccb
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions doc/dev-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,18 @@ $ git rebase main
$ ./scripts/make_doc.sh
```

### 4. Commit the result docs
### 4. Remove the line containing `docs/` in .gitignore temporarily
```sh
$ grep -v 'docs/' .gitignore > tmp.txt && mv tmp.txt .gitignore
```

### 5. Commit the result docs
```sh
$ git add docs/*
$ git commit -s -m "Bump to latest main branch"
```

### 5. Deploy the docs to the remote site
### 6. Deploy the docs to the remote site
```sh
$ git push origin gh-pages --force
```
Expand Down

0 comments on commit 9338ccb

Please sign in to comment.