Skip to content

Commit 4d35d17

Browse files
mfranciscDevtools
andauthored
hide footer, minor readme fixes (#750)
Co-authored-by: Devtools <devtools@redhat.com>
1 parent ab00b67 commit 4d35d17

2 files changed

Lines changed: 10 additions & 35 deletions

File tree

workspaces/sandbox/README.md

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,12 @@ This plugin provides the new developer sandbox experience for the Red Hat Develo
44

55
## Configuration
66

7-
This plugin needs the following to be configured in the `app-config.yaml` file:
7+
This plugin needs the following to be configured in the `app-config.local.yaml` file:
88

99
1. The URL of the registration-service-api production server.
1010
2. The URL of the kube-api production server.
1111
3. The site key for Google Recaptcha. The keys can be obtained from the Google Recaptcha admin console.
1212

13-
## Dynamic Plugin Configuration
14-
15-
This is the configuration that needs to be added to the `app-config.yaml` file to enable the sandbox dynamic plugin:
16-
17-
```yaml
18-
dynamicPlugins:
19-
frontend:
20-
red-hat-developer-hub.backstage-plugin-sandbox:
21-
appIcons:
22-
- name: homeIcon
23-
importName: SandboxHomeIcon
24-
- name: activitiesIcon
25-
importName: SandboxActivitiesIcon
26-
dynamicRoutes:
27-
- path: /
28-
importName: SandboxPage
29-
menuItem:
30-
icon: homeIcon
31-
text: Home
32-
- path: /activities
33-
importName: SandboxActivitiesPage
34-
menuItem:
35-
icon: activitiesIcon
36-
text: Activities
37-
```
38-
39-
## Development
40-
41-
To start the app, run:
42-
4313
```sh
4414
yarn install
4515
yarn dev
@@ -51,14 +21,16 @@ To generate knip reports for this app, run:
5121
yarn backstage-repo-tools knip-reports
5222
```
5323

54-
## Local Frontend Setup (provisional)
24+
## Development
5525

56-
The Sandbox plugin uses Red Hat SSO to authenticate users accessing the Sandbox backend. This section explains how to configure your local RHDH Sandbox UI to connect with Red Hat SSO and the Sandbox backend.
26+
To start the app locally, run:
5727

58-
0. `export QUAY_NAMESPACE=<your-quay-namespace>`
5928
1. `cd workspaces/sandbox`
6029
2. `yarn install`
6130
3. `make start-rhdh-local`
6231

6332
Please, note that every time you want to re deploy, you need to run:
6433
`make stop-rhdh-local`
34+
35+
NOTE: the app uses prod RH SSO as auth provider and sandbox stage backend by default
36+
( those can be configured in `app-config.local.yaml` )

workspaces/sandbox/plugins/sandbox/src/components/SandboxCatalog/SandboxCatalogPage.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import { makeStyles } from '@material-ui/core/styles';
2020
import { Page, Content } from '@backstage/core-components';
2121
import { SandboxCatalogBanner } from './SandboxCatalogBanner';
2222
import { SandboxCatalogGrid } from './SandboxCatalogGrid';
23-
import { SandboxCatalogFooter } from './SandboxCatalogFooter';
2423
import { SandboxProvider } from '../../hooks/useSandboxContext';
2524
import { SandboxHeader } from '../SandboxHeader';
2625

@@ -42,7 +41,11 @@ export const SandboxCatalogPage = () => {
4241
<Box style={{ padding: '48px 60px 48px 60px' }}>
4342
<SandboxCatalogGrid />
4443
</Box>
44+
45+
{/*
46+
/* TODO enable this later once https://issues.redhat.com/browse/SANDBOX-1161 is implemented
4547
<SandboxCatalogFooter />
48+
*/}
4649
</Content>
4750
</Page>
4851
</SandboxProvider>

0 commit comments

Comments
 (0)