-
Notifications
You must be signed in to change notification settings - Fork 95
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cleanup of the docs folder and Contributing
This PR is a major overhaul of the content in our docs folder. I found some loose threads as part of this work so I pulled on them, which is why there are so many changes. Major changes: - Reorganize of docs/contributing - Rewrite of contributing.md - Lots of NEW content (how to contribute, how to file issues, how to file pull requests, how to work on tests) - Lots of old/unused cruft removed
- Loading branch information
Showing
49 changed files
with
671 additions
and
1,329 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,10 +2,28 @@ | |
|
||
Radius is in an early phase of development right now. We welcome feedback in the form of issues that comes from usage and is aligned with the current scope and goals of the project. | ||
|
||
We welcome small PR contributions from outside the core team (docs improments, bug fixes, minor features.) as long as they follow a few guidelines: | ||
## Table of contents | ||
|
||
- Please start by [opening an issue](https://github.com/project-radius/radius/issues/new/choose) unless is it truly minor (ex: correcting a typo) | ||
- Please work with the [core team](mailto:[email protected]) to ensure that what you're doing is in scope for the project before writing any code | ||
You can find our full **contributor documentation** including instructions at the following links: | ||
|
||
- [How to contribute](./docs/contributing/how-to.md) | ||
- [See "good first issues"](https://github.com/project-radius/radius/issues?q=is:issue+is:open+label:%22good+first+issue%22) | ||
- [Install prerequisites](./docs/contributing/contributing-code/contributing-code-prerequisites/) | ||
- [Create your first commit (full walkthrough)](./contributing-code-first-commit/first-commit-00-prerequisites.md) | ||
- [Building the repo](./docs/contributing/contributing-code/contributing-code-building/) | ||
- [Understanding repo organiztion](./docs/contributing/contributing-code/contributing-code-organization/) | ||
- [Contribute to issues](./docs/contributing/contributing-issues/) | ||
- [Create pull requests](./docs/contributing/contributing-pull-requests/) | ||
- [Contribute to documentation](https://github.com/project-radius/docs) | ||
|
||
## Current status | ||
|
||
We welcome small pull request contributions from anyone (docs improments, bug fixes, minor features.) as long as they follow a few guidelines: | ||
|
||
- For very minor changes like correcting a typo feel free to send a pull request. Otherwise ... | ||
- Please start by [choosing an existing issue](https://github.com/project-radius/radius/issues), or [opening an issue](https://github.com/project-radius/radius/issues/new/choose) to work on. | ||
- The maintainers will respond to your issue, please work with the maintainers to ensure that what you're doing is in scope for the project before writing any code. | ||
- If you have any doubt whether a contribution would be valuable, feel free to ask. | ||
|
||
## Code of conduct | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,9 @@ | ||
# Project Radius documentation | ||
|
||
The docs for Project Radius are at https://radapp.dev, with the source in the [project-radius/docs repo](https://github.com/project-radius/docs). | ||
The documentation for Project Radius is at https://radapp.dev, with the source in the [project-radius/docs repo](https://github.com/project-radius/docs). | ||
|
||
## Contributing to Project Radius | ||
|
||
To contribute to Project Radius, refer to the [contributing docs](./contributing/). | ||
This folder contains the documentation for contributing to Radius. | ||
|
||
To browse the table of contents, refer to the [contributing docs](./../CONTRIBUTING.md). |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
46 changes: 0 additions & 46 deletions
46
docs/adr/bicep-extensibility/001-bicep-extensibility-types.md
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.