Skip to content

Commit

Permalink
Fix documentation not being built or deployed.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonwo committed Mar 14, 2024
1 parent 720aae4 commit f8664bc
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 15 deletions.
12 changes: 1 addition & 11 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ jobs:
make spellcheck-docs
build:
if: |
github.event_name == 'pull_request' &&
!contains(github.event.pull_request.labels.*.name, 'do-not-merge') &&
!contains(github.event.pull_request.labels.*.name, 'wip')
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand All @@ -37,15 +33,9 @@ jobs:
path: docs/build/

deploy:

runs-on: ubuntu-latest
needs: build
if: |
github.event_name == 'pull_request' &&
github.ref == 'refs/heads/main' &&
!contains(github.event.pull_request.labels.*.name, 'do-not-merge') &&
!contains(github.event.pull_request.labels.*.name, 'wip')
if: github.ref == 'refs/heads/main'

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: exec
## Description

The `bacalhau exec` command allows for the specification of jobs to be executed from the command line,
without the need for a job specification file (see [job run](../job/run/)).
without the need for a job specification file (see [job run](/dev/cli-reference/cli/job/run/)).

## Usage

Expand Down
3 changes: 1 addition & 2 deletions docs/docs/setting-up/running-node/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ We'll add instructions for your favorite OS.
## Quick start (Ubuntu 22.04)

Estimated time for completion: 10 min.

Tested on: Ubuntu 22.04 LTS (x86/64) running on a GCP e2-standard-4 (4 vCPU, 16 GB memory) instance with 40 GB disk size.

### Prerequisites
Expand Down Expand Up @@ -182,7 +181,7 @@ Firewall configuration is very specific to your network and we can't provide gen

### Install the Bacalhau Binary

[Install the bacalhau binary](./../getting-started/installation.md#install-the-bacalhau-cli) to run `bacalhau serve`.
[Install the bacalhau binary](/getting-started/installation.md#install-the-bacalhau-cli) to run `bacalhau serve`.

:::info

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/topic-guides/custom-job-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Within the CLI each custom job type requires a template file,
a JSON representation of the job with a .tpl extension,
found in the [templates folder](https://github.com/bacalhau-project/bacalhau/tree/main/cmd/cli/exec/templates). This template defines the base components of the job and is extended by the command line parameters provided to exec.

In addition to the usual runtime and specification flags, that can be found in [the CLI reference for exec](../references/cli/exec/), the `--code` parameter allows for single code files, or directories of code files to be added to the specification. By default they will be added inline to the job specification, although the requester node may chose to change the storage provider for the code. There is however a hard-limit of 10MB for the attached code.
In addition to the usual runtime and specification flags, that can be found in [the CLI reference for exec](/dev/cli-reference/cli/job/exec/), the `--code` parameter allows for single code files, or directories of code files to be added to the specification. By default they will be added inline to the job specification, although the requester node may chose to change the storage provider for the code. There is however a hard-limit of 10MB for the attached code.


## Requester node
Expand Down

0 comments on commit f8664bc

Please sign in to comment.