-
Notifications
You must be signed in to change notification settings - Fork 22
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
Add initial documentation #6
Conversation
README.md
Outdated
|
||
### Start forklift operator server without authentication: | ||
|
||
Start the [forklift-operator](https://github.com/konveyor/forklift-controller) inventory server on `http://localhost:8080` withut authentication. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/withut/without
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed the start forklift section
README.md
Outdated
1. `oc login` (requires [oc](https://console.redhat.com/openshift/downloads) and an [OpenShift cluster](https://console.redhat.com/openshift/create)) | ||
2. `AUTH_REQUIRED=false make run` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will not work with OpenShift cluster
but with the minikube
and even with it we need some extra steps like kubev2v/forklift-operator#239
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed this section from the readme
90aae28
to
d52e34c
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #6 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 1
Lines ? 8
Branches ? 0
========================================
Hits ? 8
Misses ? 0
Partials ? 0 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
d404699
to
f899039
Compare
f899039
to
7724398
Compare
Populate the projects README file, and add a docs directory.