Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
lukpueh opened this issue Apr 4, 2024 · 3 comments
Open

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

lukpueh opened this issue Apr 4, 2024 · 3 comments

Comments

@lukpueh
Copy link
Member

lukpueh commented Apr 4, 2024

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)
@lukpueh
Copy link
Member Author

lukpueh commented Apr 4, 2024

If there's a consensus to do this, I'm happy to kick off the repo renames.

@acornforth
Copy link

acornforth commented Apr 25, 2024

Hey guys, just to add to this... I cam across this project on CNCF website, My Spanish-speaking partner laughed out loud, not believing this was the real name of an organisation....

In case you weren't aware, "toto" is how little girls refer to their girl parts in spain...

Not something one would ordinarily want to associate with "open and extensible", or "extensive tooling"... just saying.

https://www.spanishdict.com/translate/toto

@lukpueh
Copy link
Member Author

lukpueh commented May 27, 2024

  • Rename docs to specification

Done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants