This updates and cleans up README a bit. There were two API sections that got merged and moved under frontend development. Some typos were also addressed.
Let's save our contributors a hop and not link to the (deprecated)
devel/README.md anymore, which is only a placeholder pointing to
osubild-getting-started. Let's instead direct folks there in the first
place.
We have replaced the Travis CI with a Github action, `dev-checks.yml`.
Travis is less reliable than the Github dev checks, recently it has been
flaking on timeouts. Additionally, removing it will allow us to move the
owner of the image-builder-frontend repository from RedHatInsights to
osbuild.
The edge images table is going to be integrated in the frontend code
base in the coming weeks. To help smooth that development process there
is need for a feature flag that would keep the current behavior running
on stage and prod while the new image table is being developed.
For now dummy code is returned for when the flag is on, and legacy
behavior keeps on going when the flag is off.
The stage flag can be seen there:
- https://insights-stage.unleash.devshift.net/projects/default/features/image-builder.edge.local-image-table
The prod flag can be seen there:
- https://insights.unleash.devshift.net/projects/default/features/image-builder.edge.local-image-table
The commit brings in some documentation in the Readme. Any member of
the team should be able to follow these steps to add in new feature
flags and use them in the code base.
The commit also brings in two new testing files for the future
components to come. For now these tests only check that the mocking
value for the unleash flag is properly set.
This commit updates the readme to reflect the use of
`@rtk-query/codegen` for generating API slice definitions and adds a new
script, `api.sh`, that is used to generate the API slices when the user
runs `npm run api`.
Update the start scripts to match the updated scripts
in the `package.json`. Additionally, add instructions
for forwarding the domains to localhost for the stage
and prod since this is only mentioned in the `devel/`
readme.
This integrates all the Image Builder components needed by the
cloud.redhat.com frontend and allows them to be developed and run
locally using `docker compose`.
This should make it simple to make patches across the different
components and develop them in tandem.
Thanks to Achilleas Koutsou for the initial idea and implementation
in osbuild-composer.
Signed-off-by: Tom Gundersen <teg@jklm.no>
