Skip to content

Commit

Permalink
Dogfood odo for working on the website (#6564)
Browse files Browse the repository at this point in the history
* Add 'devfile.yaml' for working on the website

* Git-ignore the '.odo' folder

* Make Docusaurus listen on all interfaces

By default, Docusaurus would listen only on the loopback interface,
which does not work with Podman at this time (see [1]).

[1] #6510 (comment)
  • Loading branch information
rm3l authored Feb 2, 2023
1 parent d1760ce commit c47a3d3
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

.odo
59 changes: 59 additions & 0 deletions docs/website/devfile.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
schemaVersion: 2.2.0
metadata:
name: odo.dev
description: Website for odo, the developer-focused CLI for container development
displayName: odo.dev
icon: https://odo.dev/img/logo.png
version: 3.6.0
tags:
- NodeJS
- React
- Docusaurus
- odo

components:
- name: doc-runtime
container:
image: registry.access.redhat.com/ubi8/nodejs-16:latest
memoryLimit: 512Mi
command: ['tail']
args: ['-f', '/dev/null']
endpoints:
- name: http-doc
targetPort: 3000

commands:

- id: 0-install-yarn
exec:
commandLine: npm install --global yarn
component: doc-runtime

#
# Build
#
- id: doc-install-deps
exec:
commandLine: yarn
component: doc-runtime
workingDir: ${PROJECT_SOURCE}
group:
kind: build
isDefault: true

#
# Run
#
- id: doc-start
exec:
commandLine: yarn start
component: doc-runtime
hotReloadCapable: true
workingDir: ${PROJECT_SOURCE}
group:
kind: run
isDefault: true

events:
postStart:
- 0-install-yarn
2 changes: 1 addition & 1 deletion docs/website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"start": "docusaurus start --host 0.0.0.0",
"build": "docusaurus build && ./build_godoc.sh",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
Expand Down

0 comments on commit c47a3d3

Please sign in to comment.