Figure out a better way to handle project detail call to action
Problem to solve
Projects, and repositories by extension, are used for many things and not all of them are related to code. In the Project Details
section of a Project, we have a number of call to actions such as
- Add README
- Add LICENSE
- Add CONTRIBUTING
- Enable Auto DevOps
- Add Kubernetes cluster
- Set up CI/CD
The problem is not all of these CTAs are actually applicable to all projects. For example, for closed source software, there will likely not be a license or contributors in the repository, yet we will always display a call to add them. See the screenshot for example:
User experience goal
We should never display CTAs that don't make sense in context.
Proposal
There are a few possible proposals:
- Make these CTAs dismissible on a project level basis. If they are dismissed, they never return and can't be recovered.
- Be smarter about which CTAs we show in the first place. If the project is private, don't show the license and contributor CTAs, if there isn't an existing K8s cluster, don't show the K8s CTA.
- Do both
Documentation
Regardless of implementation, we should likely add a docs page that outlines best practices for repository setup for various use cases.