swagger-api / swagger-api/swagger.io-docs

Dockerfile doesn't build anything

Open
#183 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Astro
Stars
1.6k
Forks
407
Avg merge
2m
Merged PRs (30d)
2

Description

In tools-documentation/documentation.md there's a section Swagger UI Documentation → Customization → Build → Build from Docker (link to website).

I can't see anything in the Dockerfile that builds something, all it does is copying the contents of dist into the image to be served by Nginx.

Maybe I've missed something, if not this is pretty misleading.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read tools-documentation/documentation.md and inspect the referenced Dockerfile, especially how it uses dist and serves content through Nginx. Confirm whether the “Build from Docker” description matches the Dockerfile, then update the documentation so its behavior is accurate and verify the revised section is no longer misleading.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, nginx
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.