Skip to content

Rename in-toto/in-toto and in-toto/docs #22

Description

@lukpueh

The repositories names for the in-toto python implementation (in-toto) and for the in-toto specification (docs) are ambiguous and/or misleading. They can be easily mistaken for a project "landing page" (in-toto) or general project documentation (docs).

Proposed fix

  • Rename docs to specification
  • Rename in-toto to in-toto-python (like in-toto-golang, in-toto-java, in-toto-rs), or python-in-toto (like python-tuf, go-witness)
  • Use language -typical doc platforms for API documentation (e.g. readthedocs, godoc, etc.)
  • Use in-toto.io as project landing page and place for general project documentation
    • Repurposing in-toto or docs would be nice, but it seems safer to not reuse the names and instead use forwarding to preserve existing links
    • in-toto.io could include quick start guides with cli examples, where the used programming language doesn't matter (should probably only pick one of the (3!) co-existing in-toto cli)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions