Skip to content

Proposal: Making better usage of this repository #16

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

Closed
angerson opened this issue Nov 30, 2020 · 4 comments
Closed

Proposal: Making better usage of this repository #16

angerson opened this issue Nov 30, 2020 · 4 comments
Assignees

Comments

@angerson
Copy link
Contributor

@perfinion and I have been stuck on making the most of this tensorflow/build repo, so I put together a little policy proposal that should help our goals:

  1. Showcase and emphasize community build-related projects and resources
  2. Require minimal upkeep and decision-making from the repo owners

With those in mind, consider these new rules defining what goes into the repo:

Repo Guidelines

  1. The repo's README is a list of items that can be one of two things:
    1. Link to an external repository with a brief description
    2. Description of a subfolder in the repo.
  2. Subfolders can be either:
    1. Code for a small bit of code, or a guide, or documentation (Why not a wiki?: GitHub wikis don't have PRs or ownership.) -- anything, but it should be small.
      • The README's header includes the same subfolder description and attribution as in the root README.
      • The attribution matches up with an entry in the root CODEOWNERS file for the directory.
      • CI: If CI is important we'd prefer a separate repo be used, but small things like GitHub actions should be OK. We'll have to see some examples before making a decision on this.
    2. A collection of subfolders with a common theme, e.g. a bunch of independent Docker projects.
      • All root README descriptions will be moved into this folder's README.
      • This isn't necessary until many similar folders are added.

With this, the repo can hold anything, in a simple structure, with clear ownership, like Windows Subsystem for Linux guides or the Dockerfiles we currently have or SIG Build-official guides for resource usage (once we get around to them...). We'll have to rearrange a couple things, but nothing major. It'll be a nice way to formalize a showcase & guide.

I think we can use this to similarly extract more community stuff from the main tensorflow/tensorflow repo, which will let us feature more community projects. We'll leave the Community Builds table on the main README until we see a reason to migrate it (like if this plan works really well).

What are your thoughts? Leave a comment and/or join us in Dec. 1st's meeting (see http://bit.ly/tf-sig-build-notes).

@angerson
Copy link
Contributor Author

With this we can also better-clarify goals, e.g. our long-running goal to provide some sort of cache for easier builds would be a folder with a guide (and any example config files) on how to use it, owned by whomever sets it up. It's a good way to encapsulate lots of arbitrary things.

@Avditvs
Copy link
Contributor

Avditvs commented Dec 4, 2020

Hello, as discussed in tensorflow/docs#1757, I'm ready to create the pull request.
@angerson can you let me know when the folders are rearranged ?

@angerson
Copy link
Contributor Author

angerson commented Dec 4, 2020

@Avditvs have a look at #17 -- once that's in, you should be able to make your PR.

angerson added a commit that referenced this issue Dec 15, 2020
@angerson
Copy link
Contributor Author

@Avditvs Done, feel free to submit a new PR with your guide!

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