search

bowtie-json-schema / bowtie

JSON Schema in every programming language
https://bowtie.report/
Other
55 stars 41 forks source link

Populate the GitPod MOTD with some simple Bowtie documentation #695

Closed Julian closed 9 months ago

Julian commented 11 months ago

It would probably be useful to have the MOTD in our new Gitpod support show some example commands for using Bowtie.

Probably mirroring the ones from the top of the CLI docs is a good start.

sudo-jarvis commented 9 months ago

Hi @Julian, I was trying to add the bowtie cli documentation to the MOTD for the gitpod workspace, however it seems that by default the motd file of gitpod has some default content.

However, whenever creating a gitpod workspace and accesing it from the terminal there is no message displayed ( not even the default one ), so ig motd isnt displayed to the user in gitpod workspace

We can probably run the command gp open on init to open the documentation file by default on workspace start

Julian commented 9 months ago

Hey! Nice, I think this is a good one to tackle as well!

however it seems that by default the motd file of gitpod has some default content.

(I don't mind completely replacing it, or appending to it)

However, whenever creating a gitpod workspace and accesing it from the terminal there is no message displayed ( not even the default one ), so ig motd isnt displayed to the user in gitpod workspace

Yeah I noticed that I think as well -- but that's only via the web UI -- if you create a workspace and then use Gitpod's "Connect via SSH" you should see it -- I think the web UI must not use a login shell. You should see that if you start a workspace and then click the "Connect via SSH" option and SSH to the machine from your own.

Perhaps as a first version it's fine if this only shows up via SSH -- I think the main important bit to start is just defining the contents of the message, and then we can expand where we show it. Maybe start there? Another possibility is to go ask GitPod whether we can get it to work in the web UI too. They have a Discord with some staff members who are sometimes around and answer.

sudo-jarvis commented 9 months ago

I think the content can be the same as what is shown on running bowtie --help with an added examples section maybe

I think the main important bit to start is just defining the contents of the message

Julian commented 9 months ago

That sounds pretty reasonable!

sudo-jarvis commented 9 months ago

Hi @Julian I have implemented the same and have created a PR for the same, kindly check.