We can move the project website directory into a separate repo, so it doesn't get accidentally conflicted by the main site's styles and maintains its separate history.
There are three options:
- Create a repo with the same domain subdirectory that you'd like to have.
Any github pages repo created in the organization will get the subdirectory name, i.e., orderlab.io/<repo_name>. For example, creating a DSD-Bench repo and making it a github pages will be accessible through orderlab.io/DSD-Bench. This is the simplest option.
- Maintain the website in a sub directory in the project repo (still a separate repo).
This would be useful if the name is more suited for the main project's code and docs, instead of just the website. For example, if DSD-Bench is the repo for the main benchmark content, we can create a www directory within this repo and configure github pages to deploy from this subdirectory instead of the root directory.
- Use github workflow to checkout the pre-built website.
The following is an example:
|
- name: Checkout prebuilt LeaseOS website |
|
uses: actions/checkout@v4 |
|
with: |
|
repository: orderlab/leaseos-www |
|
ref: gh-pages |
|
path: leaseos-built |
|
|
|
- name: Add LeaseOS to the main site |
|
run: | |
|
rm -rf _site/LeaseOS |
|
mkdir -p _site/LeaseOS |
|
|
|
# Exclude Git metadata from the published site. |
|
rsync -a \ |
|
--exclude='.git' \ |
|
--exclude='.github' \ |
|
leaseos-built/ _site/LeaseOS/ |
We can move the project website directory into a separate repo, so it doesn't get accidentally conflicted by the main site's styles and maintains its separate history.
There are three options:
Any github pages repo created in the organization will get the subdirectory name, i.e.,
orderlab.io/<repo_name>. For example, creating aDSD-Benchrepo and making it a github pages will be accessible throughorderlab.io/DSD-Bench. This is the simplest option.This would be useful if the name is more suited for the main project's code and docs, instead of just the website. For example, if
DSD-Benchis the repo for the main benchmark content, we can create awwwdirectory within this repo and configure github pages to deploy from this subdirectory instead of the root directory.The following is an example:
orderlab.github.io/.github/workflows/deploy.yml
Lines 45 to 61 in ed6ce87