Fix bugs in documentation and reenable algolia search #3781

MichaelHoepler · 2024-04-11T16:45:34Z

This is the PR for just the changes in the docs.

coderabbitai · 2024-04-11T16:46:12Z

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

frrist · 2024-04-18T16:06:51Z

@MichaelHoepler feel free to ping me when this is out of draft for a review.

MichaelHoepler · 2024-04-26T10:01:36Z

@frrist Did you take a look at the PR?

frrist

Leaving an early comment (I am still reviewing) please revert all changes that are only adding trailing whitespace to the end of lines. There are quite a few of these and it's causing the diff of the PR to be larger (and harder to review) than need be.

In general, aim to make modifications to the docs only where necessary to keep the PR small and review easy. Right now it's a little hard to tell what's changed.

frrist · 2024-04-22T15:23:38Z

docs/docs/all-flags.md

@@ -354,7 +354,7 @@ bacalhau list
 bacalhau list --output json
 ```

-## Logs
+## Logs 


a lot of trailing spaces have been added here and else where, we should avoid this.

frrist · 2024-04-22T15:24:07Z

docs/docs/dev/api/agent.md

@@ -1,5 +1,5 @@
 ---
-sidebar_label: Agent
+sidebar_label: Agents


keep this singular

frrist · 2024-04-22T15:24:38Z

docs/docs/dev/auth_flow.md

-# Authorization and authentication flow
+# Authorization/authentication flow


Authentication and Authorization are separate things, so keep the "and"

frrist · 2024-04-26T19:13:36Z

docs/docs/all-flags.md

 ```yaml
 spec:
-  engine: Docker
-  verifier: Noop
-  publisher: IPFS
-  docker:
-    image: ubuntu
-    entryPoint:
-      - echo
-    parameters:
-      - Hello
-      - World
-  outputs:
-    - name: outputs
-      path: /outputs
+    engine: Docker
+    verifier: Noop
+    publisher: IPFS
+    docker:
+        image: ubuntu
+        entryPoint:
+            - echo
+        parameters:
+            - Hello
+            - World
+    outputs:
+        - name: outputs
+          path: /outputs
 deal:
-  concurrency: 1
+    concurrency: 1
 ```


yaml is space sensitive, and it looks like you have made modifications here (I assume they were unintentional) please ensure this yaml is still valid and revert this change if its not.

frrist · 2024-04-26T19:14:01Z

docs/docs/all-flags.md

-      --network network-type             Networking capability required by the job (default "nats")
+      --network network-type             Networking capability required by the job (default None)


revert this, the default network is nats.

frrist

I am going to pause on reviewing this further. The current PR modifies over 70% of the files making up our docs. It is unreasonable to expect a complete review of a PR this size. Please consider taking the following steps to make this work reviewable:

Revert all changes which only modify white space.
Separate the work done here into multiple PRs with clear descriptions and motivation for the changes they are making.
Separate PRs that change document content from PRs that change document styling.

I am all for making our docs better, but we need to approach making these changes with care, and we can do that by breaking this down into reviewable pieces of work.

On the other hand, if you are confident the changes here are correct and would prefer to merge this now and fail forward - making adjustments in follow on PRs - I am good with that too.

frrist · 2024-04-26T19:18:42Z

docs/docs/community/compute-landscape.md

@@ -8,7 +8,7 @@ sidebar_position: 2
 This page is an introduction to a landscape analysis of general-purpose compute frameworks.


revert changes to this file.

frrist · 2024-04-26T19:18:58Z

docs/docs/community/style-guide.md

@@ -14,14 +14,14 @@ The primary objective of the Bacalhau documentation style guide is to help autho

 Our goal is to use conversational tone that is natural, and friendly towards the reader and also ensure that the document's content is simple and easy to follow.


revert changes to this file

frrist · 2024-04-26T19:19:22Z

docs/docs/dev/api/index.md

@@ -4,19 +4,19 @@ Welcome to the official API documentation for Bacalhau. This guide provides a de



revert changes to this file

frrist · 2024-04-26T19:20:53Z

docs/docs/dev/auth_flow.md


 Bacalhau authenticates and authorizes users in a multi-step flow.

-## Requirements


What is the motivation for changing this file? A lot of this content was helpful, why is it being removed?

frrist · 2024-04-26T19:27:27Z

docs/docs/dev/other-specifications/engines/docker.md

+## Notes
+
+- Currently, only images published to public registries are supported. Make sure your image is available in one of them, for example DockerHub or ghcr. Private images can be retrieved from docker hub by [specifying your credentials](../../../setting-up/running-node/quick-start-docker.md#authenticate-with-docker-hub).
+- Make sure that the architecture of your image matches the architecture of the nodes in your cluster. Also consider the possibility of using [multi-platform](https://docs.docker.com/build/building/multi-platform/) images.


Currently, only images published to public registries are supported

I don't think this is true. The docker daemon attached to the compute node can pull containers it has credentials to access.

Private images can be retrieved from docker hub by ...

Okay now we walk it back, this is correct, we can fetch private images if credentials are provided

Please fix this section, its confusing.

frrist · 2024-04-26T19:33:46Z

docs/docs/dev/other-specifications/publishers/s3.md

@@ -70,6 +78,7 @@ Publisher:
    Bucket: "my-task-results"
    Key: "task123/result.tar.gz"
    Endpoint: "https://s3.us-west-2.amazonaws.com"
+    Compress: true


frrist · 2024-04-26T19:34:09Z

docs/docs/dev/other-specifications/publishers/s3.md

-3. **Using naming placeholders**:
+3. **Docker job writing a single archived file to S3**:
+   ```bash
+   bacalhau docker run -p s3://bucket/key,opt=compress=true ubuntu ...


cc @wdbaruni I believe we remove compress as an option.

frrist · 2024-04-26T19:34:36Z

docs/docs/dev/other-specifications/sources/ipfs.md

@@ -41,4 +41,4 @@ Utilizing IPFS as an input source in Bacalhau via the CLI is straightforward. Be
   bacalhau docker run -i ipfs://QmeZRGhe4PmjctYVSVHuEiA9oSXnqmYa4kQubSHgWbjv72:/data ubuntu ...
   ```

-These commands provide a seamless mechanism to fetch and mount data from IPFS directly into your task's execution environment using the Bacalhau CLI.


revert this change as it appears nothing changed

frrist · 2024-04-26T19:34:46Z

docs/docs/dev/other-specifications/sources/s3.md

@@ -12,7 +12,7 @@ Here are the parameters that you can define for an S3 input source:

 - **Bucket** `(string: <required>)`: The name of the S3 bucket where the data is stored.


revert this change

frrist · 2024-04-26T19:35:42Z

docs/docs/dev/setting_up_development.md

-export GOLANGVER='1.21'
+export GOLANGVER='1.20'


revert this change. We are using 1.21

MichaelHoepler added 2 commits April 11, 2024 09:40

Add changes from the docupdating branch

286a752

Merge branch 'main' into mhoepler/docupdating-3

4f9e713

MichaelHoepler added the th/documentation Theme: Related to documentation, including tutorials and API docs label Apr 11, 2024

MichaelHoepler requested a review from frrist April 11, 2024 16:45

MichaelHoepler self-assigned this Apr 11, 2024

MichaelHoepler marked this pull request as draft April 11, 2024 16:47

MichaelHoepler added 4 commits April 11, 2024 09:49

Correcting spell checker

28c1929

Adjusting and adding redirects

f577d04

Add more redirects

a87dd7e

Update redirect

483c683

MichaelHoepler added 11 commits April 23, 2024 15:58

Fixing all broken links

ec3c043

Updating redirect

06c2a30

Removing redirect

08b8f1c

Fixing broken links

55c2d05

remove unnecessary redirect

f74d5a5

fixing broken links

e71a1a6

Fixing more broken links

7838207

Fixing more links

475ea98

Fixing more links

63c2635

Fix broken links

7f12c20

Merge branch 'main' into mhoepler/docupdating-3

54264e5

MichaelHoepler marked this pull request as ready for review April 24, 2024 12:28

Fix links and remove TODOs

c78ab36

frrist reviewed Apr 26, 2024

View reviewed changes

MichaelHoepler marked this pull request as draft April 29, 2024 07:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix bugs in documentation and reenable algolia search #3781

Fix bugs in documentation and reenable algolia search #3781

MichaelHoepler commented Apr 11, 2024

coderabbitai bot commented Apr 11, 2024 •

edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

frrist commented Apr 18, 2024

MichaelHoepler commented Apr 26, 2024

frrist left a comment

frrist Apr 22, 2024

frrist Apr 22, 2024

frrist Apr 22, 2024

frrist Apr 26, 2024

frrist Apr 26, 2024

frrist left a comment

frrist Apr 26, 2024

frrist Apr 26, 2024

frrist Apr 26, 2024

frrist Apr 26, 2024

frrist Apr 26, 2024

frrist Apr 26, 2024

frrist Apr 26, 2024

frrist Apr 26, 2024

frrist Apr 26, 2024

frrist Apr 26, 2024

		# Authorization and authentication flow
		# Authorization/authentication flow

		--network network-type Networking capability required by the job (default "nats")
		--network network-type Networking capability required by the job (default None)

		@@ -8,7 +8,7 @@ sidebar_position: 2
		This page is an introduction to a landscape analysis of general-purpose compute frameworks.

		@@ -14,14 +14,14 @@ The primary objective of the Bacalhau documentation style guide is to help autho

		Our goal is to use conversational tone that is natural, and friendly towards the reader and also ensure that the document's content is simple and easy to follow.

		@@ -4,19 +4,19 @@ Welcome to the official API documentation for Bacalhau. This guide provides a de


		Bacalhau authenticates and authorizes users in a multi-step flow.

		## Requirements

		@@ -12,7 +12,7 @@ Here are the parameters that you can define for an S3 input source:

		- Bucket `(string: <required>)`: The name of the S3 bucket where the data is stored.

		export GOLANGVER='1.21'
		export GOLANGVER='1.20'

Fix bugs in documentation and reenable algolia search #3781

Are you sure you want to change the base?

Fix bugs in documentation and reenable algolia search #3781

Conversation

MichaelHoepler commented Apr 11, 2024

coderabbitai bot commented Apr 11, 2024 • edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

frrist commented Apr 18, 2024

MichaelHoepler commented Apr 26, 2024

frrist left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frrist left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coderabbitai bot commented Apr 11, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)