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

Cleanup of the docs folder and Contributing #5619

Merged
merged 1 commit into from
Jun 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
ARROW := \033[34;1m=>\033[0m

# order matters for these
include build/help.mk build/version.mk build/build.mk build/util.mk build/generate.mk build/test.mk build/controller.mk build/docker.mk build/recipes.mk build/install.mk build/debug.mk
rynowak marked this conversation as resolved.
Show resolved Hide resolved
include build/help.mk build/version.mk build/build.mk build/util.mk build/generate.mk build/test.mk build/docker.mk build/recipes.mk build/install.mk build/debug.mk
13 changes: 0 additions & 13 deletions build/check-kcp.sh

This file was deleted.

24 changes: 0 additions & 24 deletions build/controller.mk

This file was deleted.

6 changes: 1 addition & 5 deletions build/install.mk
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,5 @@ RAD_LOCATION := /usr/local/bin/rad

.PHONY: install
install: build-binaries ## Installs a local build for development

@echo "$(ARROW) Installing rad"
cp $(OUT_DIR)/$(GOOS)_$(GOARCH)/$(BUILDTYPE_DIR)/rad$(BINARY_EXT) $(RAD_LOCATION)

@echo "$(ARROW) Displaying output"
tree $(HOME)/.rad -a
rynowak marked this conversation as resolved.
Show resolved Hide resolved
cp $(OUT_DIR)/$(GOOS)_$(GOARCH)/$(BUILDTYPE_DIR)/rad$(BINARY_EXT) $(RAD_LOCATION)
2 changes: 0 additions & 2 deletions deploy/Chart/charts/rp/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@ spec:
value: 'self-hosted'
- name: K8S_CLUSTER
value: 'true'
- name: SKIP_AUTH
value: 'true'
rynowak marked this conversation as resolved.
Show resolved Hide resolved
{{ if .Values.publicEndpointOverride}}
- name: RADIUS_PUBLIC_ENDPOINT_OVERRIDE
value: {{ .Values.publicEndpointOverride }}
Expand Down
6 changes: 4 additions & 2 deletions docs/README.md
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).
23 changes: 0 additions & 23 deletions docs/adr/000-adr-template.md

This file was deleted.

51 changes: 0 additions & 51 deletions docs/adr/001-adr-adopt-adrs.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/adr/003-shared-data-store.md

This file was deleted.

30 changes: 0 additions & 30 deletions docs/adr/README.md

This file was deleted.

46 changes: 0 additions & 46 deletions docs/adr/bicep-extensibility/001-bicep-extensibility-types.md

This file was deleted.

Loading