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

Add initial documentation #6

Merged
merged 1 commit into from
Sep 20, 2022
Merged

Add initial documentation #6

merged 1 commit into from
Sep 20, 2022

Conversation

yaacov
Copy link
Member

@yaacov yaacov commented Aug 16, 2022

Populate the projects README file, and add a docs directory.

@yaacov
Copy link
Member Author

yaacov commented Aug 16, 2022

@rszwajko @sjd78 please review

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/console.md Outdated Show resolved Hide resolved
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.
Copy link
Member

Choose a reason for hiding this comment

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

s/withut/without

Copy link
Member Author

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
Comment on lines 24 to 25
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`
Copy link
Member

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

Copy link
Member Author

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

@yaacov yaacov linked an issue Aug 21, 2022 that may be closed by this pull request
@yaacov yaacov force-pushed the add-initial-documentation branch 2 times, most recently from 90aae28 to d52e34c Compare September 20, 2022 09:35
@codecov
Copy link

codecov bot commented Sep 20, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@be71e95). Click here to learn what that means.
Patch has no changes to coverable lines.

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.
📢 Do you have feedback about the report comment? Let us know in this issue.

@yaacov yaacov force-pushed the add-initial-documentation branch 2 times, most recently from d404699 to f899039 Compare September 20, 2022 11:07
@yaacov
Copy link
Member Author

yaacov commented Sep 20, 2022

@rszwajko @sjd78 please re-review

@yaacov yaacov force-pushed the add-initial-documentation branch from f899039 to 7724398 Compare September 20, 2022 11:11
@yaacov yaacov requested review from rszwajko and mnecas September 20, 2022 11:23
@yaacov yaacov merged commit 0a9517e into main Sep 20, 2022
@yaacov yaacov deleted the add-initial-documentation branch September 20, 2022 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a README file
3 participants