Skip to content
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

Jump to bottom

ci: updated README and backport CI #1606

Merged
merged 1 commit into from
Sep 25, 2023
Merged

ci: updated README and backport CI #1606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion .dockerignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ README.md
CHANGES
.gitignore
.cache
prow/
prow/
.env
5 changes: 0 additions & 5 deletions .github/workflows/version-branch-update.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,6 @@ jobs:
run: |
netlify build --context deploy-preview

- name: compile
run: |
make build


- name: Deploy to Netlify
id: netlify
uses: nwtgck/actions-netlify@v2.1.0
Expand Down
3 changes: 2 additions & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ RUN apk add util-linux && \
chmod +x /entry.sh && \
mkdir .cache && \
npm ci && \
chown -R node:node /librarium
chown -R node:node /librarium && \
echo -e "ALGOLIA_APP_ID=1234567890\nALGOLIA_SEARCH_KEY=1234567890" > .env

EXPOSE 9000
USER node
Expand Down
1 change: 1 addition & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ help: ## Display this help
initialize: ## Initialize the repository dependencies
@echo "initializing npm dependencies"
npm ci
touch .env
npx husky-init

clean: ## Clean build artifacts
Expand Down
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ To contribute, we recommend having the following software installed locally on y

To get started with the Docker based local development approach ensure you are in the root context of this repository.

Initailize the repository by issuing the following command:

```shell
make init
```

Next, issue the following command to build the Docker image.

**Note**: The first time issuing the command may take several minutes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be :::info instead.

Expand All @@ -35,15 +41,13 @@ make docker-image

To start the Dockererized local development server, issue the command:

```
```shell
make docker-start
```

The local development server is ready when the following output is displayed in your terminal.

```shell
npm run start

> spectro-cloud-docs@4.0.0 start
> docusaurus start --host 0.0.0.0 --port 9000

Expand All @@ -62,12 +66,6 @@ To exit from the local development Docker container. Press `Ctrl + Z`.

## Local Development Setup (Non-Docker)

Make a folder somewhere you can easily find

```sh
mkdir ~/Work
```

Clone the repository and run the initialization script

```sh
Expand All @@ -77,6 +75,13 @@ cd librarium
make init
```

Next, populate the `.env` file with the following content. The local development server will not start without the required environment variables. The values are not important for local development.

```shell
ALGOLIA_APP_ID=1234567890
ALGOLIA_SEARCH_KEY=1234567890
```

## Documentation Content

Create a branch to keep track of all your changes.
Expand Down