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.

Sign up for GitHub

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

docs: update some janus and showcase references #2165

Merged
merged 3 commits into from
Jan 9, 2025
Merged

docs: update some janus and showcase references #2165

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
090cb13
docs: update some janus and showcase references
christoph-jerolimov Jan 9, 2025
0b5af3c
Update README.md
nickboldt Jan 9, 2025
9053ae3
Merge branch 'main' into update-readme
nickboldt Jan 9, 2025
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
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# Janus Showcase
# Red Hat Developer Hub (RHDH)

[0]: https://quay.io/repository/janus-idp/backstage-showcase

[![Quay.io registry](https://img.shields.io/badge/Quay.io-janus--idp/backstage--showcase:latest-white?logoColor=white&labelColor=grey&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI0NSIgaGVpZ2h0PSIzOS43IiB2aWV3Qm94PSIwIDAgMzkuNyAzOS43Ij48ZyB0cmFuc2Zvcm09Im1hdHJpeCguMzk0NTggMCAwIC4zOTQ1OCAxLjA4MiAuMTA1KSI+PGNpcmNsZSBjeD0iNTUuMDY5IiBjeT0iNTAiIHI9IjUwIiBmaWxsPSIjRDcxRTAwIi8+PHBhdGggZmlsbD0iI0MyMUEwMCIgZD0iTTkwLjQyOSAxNC42NDFjMTkuNTI5IDE5LjUyOSAxOS41MjkgNTEuMTkgMCA3MC43MTgtMTkuNTI5IDE5LjUzLTUxLjE5MiAxOS41My03MC43MiAwbDcwLjcyLTcwLjcxOHoiLz48cGF0aCBmaWxsPSIjRkZGIiBkPSJtNTkuNjA4IDQ5Ljk5IDE1LjA2IDMxLjg2OWgtMTIuODNMNDYuNzg5IDQ5Ljk5bDE1LjA0OS0zMS44NWgxMi44M3oiLz48cGF0aCBmaWxsPSIjQjdCN0I3IiBkPSJtNzQuNjY4IDgxLjg1OSAxNS4wNS0zMS44NjktMTUuMDUtMzEuODUtNi40MSAxMy41NiA4LjY0IDE4LjI5LTguNjQgMTguMzAxeiIvPjxwYXRoIGZpbGw9IiNGRkYiIGQ9Im0zMy4yMzkgNDkuOTkgMTUuMDYgMzEuODY5aC0xMi44M0wyMC40MTkgNDkuOTlsMTUuMDUtMzEuODVoMTIuODN6Ii8+PHBhdGggZmlsbD0iI0I3QjdCNyIgZD0ibTQ4LjY1OSA0Ni4wNCA2LjQxLTEzLjU3LTYuNzctMTQuMzMtNi40MiAxMy41N3pNNDEuODc5IDY4LjI5MWw2LjQyIDEzLjU2OCA2Ljc3LTE0LjMzLTYuNDEtMTMuNTY4eiIvPjwvZz48L3N2Zz4K)][0]

## Purpose

Our purpose for this project is to first showcase the value of the plugins that we have created. These include the ArgoCD, GitHub Issues, Keycloak, Kubernetes, OCM, Tekton, and Topology plugin. Each of these plugins have been hand picked or created by the Janus IDP team for their practicality.
Red Hat Developer Hub is an enterprise-grade Internal Developer Portal based on Backstage.

The second purpose is to demonstrate the power of an internal developer portal using Backstage as the solution. Backstage is an application that can simplify the onboarding process for organizations with plenty of customization through the use of their plugin system.
RHDH includes the ArgoCD, GitHub Issues, Keycloak, Kubernetes, OCM, Tekton, and Topology plugin. Each of these plugins have been hand picked or created by Red Hat and the Backstage Community.

## Features

Today, we have several plugins integrated into the showcase app as a way to demonstrate the versatility of Backstage. Some of these integrations are plugins that we have built while others are ones that we see as must haves in most Backstage instances.
Today, we have several plugins integrated into RHDH as a way to demonstrate the versatility of Backstage. Some of these integrations are plugins that we have built while others are ones that we see as must haves in most Backstage instances.

Our current list of plugins within the showcase app include:
Our current list of plugins include:

- [OCM plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/ocm/plugins/ocm)
- [Quay plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/quay/plugins/quay)
- [Kubernetes plugin](https://github.com/backstage/backstage/tree/master/plugins/kubernetes)
- [Topology plugin](https://github.com/janus-idp/backstage-plugins/tree/main/plugins/topology)
- [Topology plugin](https://github.com/backstage/community-plugins/blob/main/workspaces/topology/plugins/topology/README.md)
- [ArgoCD plugin](https://github.com/RoadieHQ/roadie-backstage-plugins/tree/main/plugins/frontend/backstage-plugin-argo-cd)
- [GitHub Insights plugin](https://github.com/RoadieHQ/roadie-backstage-plugins/tree/main/plugins/frontend/backstage-plugin-github-insights)
- [GitHub Pull Requests plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/github-pull-requests-board/plugins/github-pull-requests-board)
Expand Down Expand Up @@ -53,21 +53,21 @@ Dependencies:
- [Node.js](https://nodejs.org/en/) 18
- [yarn](https://classic.yarnpkg.com/en/docs/install#debian-stable)

Information on running the showcase app can be found in our [Getting Started](https://github.com/janus-idp/backstage-showcase/blob/main/docs/index.md) documentation. In the documentation is how to set up and run an instance of the showcase app locally. We plan to expand upon the documentation at a later point if there is enough interest in other methods for getting the app up and running.
Information on running RHDH can be found in our [Getting Started](https://github.com/redhat-developer/rhdh/blob/main/docs/index.md) documentation. In the documentation is how to set up and run an instance locally. We plan to expand upon the documentation at a later point if there is enough interest in other methods for getting the app up and running.

We are excited to see people wanting to contribute to our project and welcome anyone who wishes to participate. You are more than welcome to browse through our open issues and tackle anything you feel confident in working on.

We also welcome non code contributions in the form of bug reporting and documentation writing. If you run across any bugs in the showcase app, please raise an issue here in [GitHub](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Fbug%2Cstatus%2Ftriage&template=bug.md).
We also welcome non code contributions in the form of bug reporting and documentation writing. If you run across any bugs, please raise an issue here in [JIRA](https://issues.redhat.com/browse/RHIDP).

## Community, Discussion, and Support

[Bugs](https://issues.redhat.com/projects/RHIDP) should be filled out here on RHIDP Jira.

## Resources

Our [blog](https://janus-idp.io/blog) is a great way to see what we are up to.
For more information on our plugin offerings, consult the [RHDH Plugins](https://developers.redhat.com/rhdh/plugins) product page.

For more information on our plugin offerings, consult the [Janus IDP Backstage Plugins](https://github.com/janus-idp/backstage-plugins) repo.
Our [Red Hat Developer Blog](https://developers.redhat.com/blog) is a great way to see what we are up to.

Want to know more about Backstage, consult the [documentation](https://backstage.io/docs/overview/what-is-backstage) and [GitHub](https://github.com/backstage/backstage) repo.

Expand All @@ -84,5 +84,5 @@ If you want an image that runs on Mac M1 (arm64/aarch64) or another architecture
Check out this repo, choose the branch or tag you want to use, then build an image:

```
podman build -f docker/Dockerfile . -t janus-idp/backstage-showcase:local
podman build -f docker/Dockerfile . -t rhdh:local
```
Loading