Skip to content
New issue

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

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

Already on GitHub? # to your account

Updating docs for the project - development, Azure SQL and Kubebuilder in specific #243

Merged
merged 19 commits into from
Sep 27, 2019

Conversation

jananivMS
Copy link
Contributor

closes #102

What this PR does / why we need it:

  • Adds documentation for the general setup. running, testing, development of the operator.
  • Also adds details sopecifically about the SQL operator components and how to use it
  • Includes special tips for Kubebuild on MacOS

Special notes for your reviewer:

If applicable:

  • this PR contains documentation
  • this PR contains tests

README.md Outdated
7. Update tests and run `make test`
8. Deploy `make deploy`
1. Resource Group
2. EventHub
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like you created an eventhub file in docs/ but didn't link it here

README.md Outdated

If you make changes to the operator and want to update the deployment without recreating the cluster (when testing locally), you can use the `make update` to update your Azure Operator pod. If you need to rebuild the docker image without cache, use `make ARGS="--no-cache" update`.
For information on how to build, test and run the operator, refer to the link below.
[Building, testing and running the operator](/docs/development.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this link should be featured under a big bold header like "Installing" or "Deploying"

@jananivMS jananivMS requested a review from frodopwns September 27, 2019 21:40
Copy link
Contributor

@melonrush13 melonrush13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are really great docs, Janani. Looks great to me!

@jananivMS jananivMS merged commit eac6eb4 into Azure:azure-sql Sep 27, 2019
Porges pushed a commit that referenced this pull request May 11, 2021
* Add generation of ArmResourceSpec interface.
* Clear controller-gen zz_generated files every build.
  - This is required if there are major changes to the code
     that is being generated, and is also a good safety feature.
* Exclude a few packages a bit earlier
  - These packages were causing other issues too, which
     had been ignored in code. Moving that bypass to config
     for easier tracking.
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants