AcademySoftwareFoundation / AcademySoftwareFoundation/OpenCue
small rqd documentation issues
- Dominant language
- Python
- Stars
- 957
- Forks
- 259
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 16
Description
A couple of small Rust RQD documentation issues:
The link at https://docs.opencue.io/docs/getting-started/deploying-rqd/#alternative-rust-rqd pointing to "Rust RQD Reference" points to nowhere:
https://docs.opencue.io/OpenCue/docs/reference/rust-rqd
I'm not super familiar with the OpenCue documentation structure, but I think the issue is that in:
https://github.com/AcademySoftwareFoundation/OpenCue/blob/master/docs/_docs/getting-started/deploying-rqd.md
The link:
```
[Rust RQD Reference](/OpenCue/docs/reference/rust-rqd)
```
should be:
```
[Rust RQD Reference](/docs/reference/rust-rqd)
```
Also higher up in that document under `Option 1: Building and running Rust RQD from source (Recommended)`:
```
docker build -t opencue/rqd -f rust/Dockerfile.rqd rust/
```
should probably be:
```
docker build -t opencue/rqd -f rust/Dockerfile.rqd .
```
since `rust/Dockerfile.rqd` references paths outside of the `rust/` context, for instance:
```
# Copy workspace files
COPY rust/Cargo.toml ./
COPY rust/Cargo.lock* ./
# Copy all crate directories
COPY rust/crates ./crates
# Remove symlink and copy proto files from repo root
RUN rm ./crates/opencue-proto/src/protos
COPY proto/src ./crates/opencue-proto/src/protos
```
Using `.` as the context, I was able to build the Rust `rqd` with the provided `rust/Dockerfile.rqd`.
Contributor guide
Research direction
Start in docs/_docs/getting-started/deploying-rqd.md and inspect rust/Dockerfile.rqd to confirm the documented Docker context matches its referenced paths. Done means the Rust RQD reference link resolves and the documented docker build command works from the repository root.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, rust
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100