Skip to content

Update Docker Compose references (filenames and suffixes) in Wiki articles #7719

@scottbarnes

Description

@scottbarnes

Note, this is currently blocked and cannot yet be completed.

Wiki references to docker-compose.yml need updating to compose.yaml.

Currently, the project wiki contains numerous references to docker-compose.yml. However, this nomenclature and suffix is no longer preferred. Instead, the Docker documentation prefers compose.yaml for Compose V2.

In #7626 all references to docker-compose as a command and docker-compose.yml as a filename are being updated to docker compose and compose.yaml respectively.

In #7708 the wiki references to docker-compose were updated to docker compose when invoked as a command. However, once #7626 is merged, we need to update file name references in the wiki as well, but this should not apply to historical uses of docker-compose.yml. E.g., don't historical things in the Deployment Scratchhpad for now.

If the reference is in a section from the past, please leave it. Only update 'general' references that are not a log of historical commands run or things done.

Tasks:

  1. Search the wiki for docker-compose: https://github.com/internetarchive/openlibrary/search?q=docker-compose&type=wikis
  2. Skip any historical references to file names in the past / logs of things done. This update should be prospective and apply only to general uses.
  3. Update file name references to comply with the Compose V2 standard (e.g. docker-compose.yml -> compose.yaml, docker-compose.staging.yml -> compose.staging.yaml, etc. NOTE the yml to yaml suffix change.
  4. Keep track of any pages you edit and share the links here.

Stakeholders

@cclauss
@jamstack-elise

Metadata

Metadata

Assignees

No one assigned

    Labels

    Lead: @scottbarnesIssues overseen by Scott (Community Imports)State: BlockedWork has stopped, waiting for something (Info, Dependent fix, etc. See comments). [managed]Type: Refactor/Clean-upIssues related to reorganization/clean-up of data or code (e.g. for maintainability). [managed]

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions