-
Notifications
You must be signed in to change notification settings - Fork 124
define sample apps in sample app json to be used by the console #1670
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.
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
Conversation
…are added to console sample app deployment
7883085 to
0275910
Compare
0275910 to
09ab4f2
Compare
09ab4f2 to
09f4a15
Compare
4f4d4f5 to
9f075b9
Compare
9f075b9 to
20fd36f
Compare
| **Note:** We recomend refering to the README for the sample application for details on how to run it. | ||
|
|
||
|
|
||
| > [!NOTE] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does [!xx] syntax mean?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am pretty sure this is special for Github: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Neat. I ask because I tried to open it from the commit tree, but it didn't render at all https://github.com/vespa-engine/sample-apps/blob/efad8d1dcc1179182c01d654d1a34b388cdeb4a7/README.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After further investigation it seems that GH does NOT support this in markdown documents, but only in their own makrdown fields (issues, prs, ...)
console-sample-apps.json
Outdated
| ], | ||
| "category": "Getting Started", | ||
| "repository": "https://github.com/vespa-engine/sample-apps/tree/master/album-recommendation#readme", | ||
| "zipPath": "https://data.vespa-cloud.com/console/one-click-sample-apps/album-recommendation/application.zip", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO, if we include this, we should also have path/URL to the document.jsonl. Currently Console generates that URL based on the shortname and the rest is hardcoded. Or we could remove this and generate both path/URLs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me take a look at console and implement it there first. I agree it's a bit weird to only have one
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given the Deploy action does not use this, but rather uses the "shortname" to determine the path of upload, it would make sense to use that one indeed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have updated console now to just use the shortname, so it is no problem to remove the zipPath. I can make that change
What
Why
I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.