Since the docs branch is only for GitHub pages, create a rule to protect that branch that you can't push there.
Only the user defined in the GitHub action (currently @marianfoo ) should be allowed to do this

Add:

• short description
• how to use website
• how to add repos/packages
• explain technical implementation
  • Frontend
  • Backend/Crawler

again, look at "artifact of the month"
https://github.com/SAP-samples/artifact-of-the-month/blob/main/analyzer/src/providers/npm-downloads.ts

wait for #8

Like Stars, Downloads, Updated At

Hello,

Sorry for the mess on the actions. I've been trying to get this running. But for some reason the github token is blank for me and I'm exhausting the limits. Not sure if this is because i'm not the owner of the repo?

I tried to create the file as good as possible to run the typescript scripts.
I am sure there is some improvement to be made here.

Maybe custom theme or just minimal CSS

make it more clear that this is a subpackage in a monorepo

Supported Locales and Fallback Chain
This avoids 404 calls for i18n files

Better is a Issue Template because you can link directly to it.

What are the requirements for a PR? Please add more if necessary

• add link for gh repo to source file
• add license to repo
• add keywords to root package.json
• add author/linkt to gh repo/license to package.json
• npm module published with current version
• setup publish action
• setup eslint/prettier
• add module name in ui5.yaml with specific syntax? like (ui5-module-*)
• general: what best practice to follow?
• needs review of code

You can search for packages via "tags" and in the title/description.
But I think it makes sense to assign a type to a package like "middleware" or "task".
We get most information from the package.json, so makes sense to write it here as well.

I'm writing a yeoman generator to add tooling to your ui5 project. I am using the datamodel from this repo as recommended by @petermuessig

I'm thinking that after you've selected your packages you have the option to configure the yaml file as well. For this I need the config params to be read. The easiest for me is that it's part of the data model. See (issue #1)[https://github.com/ui5-community/generator-ui5-add-extension/issues/1] The below function handles it if the jsdoc is added as a typedef and properties. See the example on my deprecated onelogin repo since the onelogin now lives in the showcase 😉

static async fetchParams(): Promise {
try {
const indexJs = await GitHubRepositoriesProvider.octokit.rest.repos.getContent({
mediaType: {
format: "raw",
},
owner: "uxkjaer",
repo: "ui5-middleware-onelogin",
path: lib/index.js,
});
const indexString = indexJs.data.toString();
const opt: jsdoc2md.JsdocOptions = {
source: indexString,
};
const data = jsdoc2md.getTemplateDataSync(opt);
const typedef: any = data.filter((x: any) => x.kind === "typedef");
let arr: any = [];
typedef[0].properties.forEach((property: any) => {
const obj = { ...property };
obj.type = obj.type.names[0];
arr.push(obj);
});
console.log(arr);
} catch (error) {
console.log(error);
}
}

Similar to bestofjs Timeline, create a timeline with the most recent updates on versions over all packages
Maybe even create a RSS Feed on the same data
Use the UI5 Timeline Control for this

you can use "List commits" via github api
https://docs.github.com/en/rest/reference/commits#list-commits

May use npm api for this, might makes more sense to get it here, especially on a monorepo

currently only works on downloads,
when using different filter downloads are not visible

similar to openui5.org and bestofjs a header with links
links can for now lead to different sortings

first start with ui5-community
With a PR Template, the list can grow

same as artifact

Do not read all packages from a monorepo

check who is contributing over every package
similar to contributors list in github like:
https://github.com/ui5-community/ui5-ecosystem-showcase/graphs/contributors

Currently only Readme is display
Add other information we already have and display that on the top
Similar to this https://bestofjs.org/projects/openui5

need to switch to "sap/ui/core/Control"

Crawling can be a action one step before website building

maybe with a splash screen or even as PWA

may sort by stars by default?
"sort by" is sketchy because of monorepos

sortable by

• stars
• forks
• updatedat
• createdat

ascending
descending

It´s not really intuitiv

We should also include theming for the Markdown control, i.e. we use the CSS variables (data-sap-ui-xx-cssVariables="additional") to get the custom theming for the TextColor as well as the links

To get a good overview, all packages need these keywords
See ui5-community/ui5-cc-chart#9

• better control over types/tags
• no PR/change on package.json needed when added to "Best of UI5"

Join all the types in the frontend instead of backend and remove from interface
see https://github.com/ui5-community/ui5-community.github.io/blob/d5e98e1c1efe7fb552c3c91eee4878ed1703cc5e/packages/crawler/src/gh-repos.ts#L128

Website can be build in seperate branch for GitHub Pages

As in bestofjs:

• downloads total
• downloads 30 days
• downloads 1 year
• add to source.json--> added to this website
• rename downloads to downloadsMonthly

Maybe crawl only when by a change in the crawler folder

sort Tags.view by count

Currently there is one view to show all tags and types
seperate them clearly by an info label
make simple sorter to show only tags or types

might need to change something in the backend

Story

As a user
i want to click on a item in the tags list
to go directly to all packages with this tag