Skip to content

Conversation

@lperry25
Copy link
Contributor

@lperry25 lperry25 commented Mar 3, 2025

What

  • Create a list of Apps that will be shown on Console
  • Add workflow to automatically publish new versions of the Sample Apps on Console
  • Update the 3 initially deployed sample apps to follow the new standard structure (album-recommendation, colbert, text-search)
  • Update documentation (README) explaining the standard structure

Why

  • Allow sample apps to be deployed from console.

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.

@esolitos esolitos force-pushed the laura/sample-apps-defs branch 4 times, most recently from 7883085 to 0275910 Compare March 18, 2025 13:28
@esolitos esolitos force-pushed the laura/sample-apps-defs branch from 0275910 to 09ab4f2 Compare March 18, 2025 13:32
@esolitos esolitos force-pushed the laura/sample-apps-defs branch from 09ab4f2 to 09f4a15 Compare March 18, 2025 15:04
@esolitos esolitos force-pushed the laura/sample-apps-defs branch 2 times, most recently from 4f4d4f5 to 9f075b9 Compare March 19, 2025 14:10
@esolitos esolitos force-pushed the laura/sample-apps-defs branch from 9f075b9 to 20fd36f Compare March 19, 2025 14:13
**Note:** We recomend refering to the README for the sample application for details on how to run it.


> [!NOTE]
Copy link
Contributor

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?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

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

Copy link
Collaborator

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, ...)

],
"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",
Copy link
Contributor

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.

Copy link
Contributor Author

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

Copy link
Collaborator

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.

Copy link
Contributor Author

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

@esolitos esolitos merged commit 2b54d6b into master Mar 25, 2025
7 of 8 checks passed
@esolitos esolitos deleted the laura/sample-apps-defs branch March 25, 2025 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants