Git Product home page Git Product logo

janus-idp.github.io's Introduction

janus-idp.github.io

This is a monorepo that contains the source code of the community website and automatically deploys to janus-idp.io.

Status

Deploy the Website to Pages Push website

Prerequisite

How to run the website locally

Install the dependencies

After getting the latest website version with git pull, you need to install the required dependencies with the following command:

pnpm i

Start the website locally

Run the following command to start the web server:

pnpm dev --filter=website

How to update the website

Go to the apps/website folder

Blog

To add or update a blog, you need to go to the blog sub folder. The blog must be in Markdown format (MDX).

Documentation

To add or update documentation, you need to go to the docs sub folder. The documentation must be in Markdown format (MD).

Plugins

To add or update a plugin, you need to edit the content/plugin-list.ts file. The content of the plugin page is coming from the README of the plugin itself in the plugin repo.

If you need to change the page template for plugins, you may need to update these files:

  • apps/website/docusaurus.config.js
  • packages/ui/components/plugin-header/plugin-header.tsx
  • packages/ui/types/index.ts

How to deploy the website

The deployment is automated as soon as a PR is merged. The build takes 2 to 3 minutes to build and deploy.

If you do not see your changes, please refresh the page in your browser.

janus-idp.github.io's People

Contributors

aayushsaini101 avatar aljesusg avatar anshttg avatar christophe-f avatar divyanshigupta avatar fmenesesg avatar jamstah avatar jayfray12 avatar kadel avatar kclibrarian avatar nrb avatar relessawy avatar renovate[bot] avatar riginoommen avatar sabre1041 avatar schultzp2020 avatar schwesig avatar serenamarie125 avatar sgahlot avatar tumido avatar zaperex avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

janus-idp.github.io's Issues

Add RSS feed for blog posts

Hi team! Can we enable an RSS feed for the blog? I hypothesize that's how some folks (like me!) are notified when new articles are published. Thanks!

Add GPT Details Page to janus-idp.github.io

Description

Provide a GPTs Details page for each of the GPTs in the GPT Home page to the Janus community site to provide the details of the Sample GPTs when the corresponding GPT Card is clicked.

Acceptance Criteria

The GPT Details Page should include the following:

Blocker

The following issue(s) will need to be completed before this issue can be started:

Slack links are not working

The invite links from the top nav and footer are not working. Also the footer links are not opening to a new page like the ones in the top nav.

Add GPTs page to janus-idp.io

Goal

The Goal of this epic is to provide a Golden Path Templates (GPTs) page to the Janus community site to provide discovery of the details of the Sample GPTs which we have available.

Enhancement

We can take inspiration from the [Plugins page[(https://janus-idp.io/plugins/) with the following changes:

GPTs Page

Header

  • Sample GPTs
  • Have a GPT idea?
  • Button -> Submit a proposal for a GPT!

The CTA should reference a new Issue template for this repo similar to this plugin issue template

Search

Include a search field, but do not provide the filter dropdown as the Plugins page has

GPT Cards

Each card should contain

  • Title
  • Description

GPT Detail Page

Header

Notes

GPTsList should include:

  • Title
  • Description
  • href
  • githubUrl

As a starter, include the following in the GPTs page:

Be sure to add README.md to the above scaffolder-templates directories if they don't exist

Issues in Epic

Add a tag filtering mechanism to the plugin page

Background

Currently the plugin page displays all plugins regardless of the plugin role specified in its package.json. e.g. 3scale-backend

Enhancement

  • Instead of using the role property, add a tags property in the plugin's package.json. This is because the role property is not easily understandable i.e. a custom action has a role of backend-plugin-module
  • Create a tag filtering mechanism based on the plugin role
  • Create a search bar based on the plugin name and tags

Create contributors guide

Essential for community members to know where to get started and how to set up the Janus Showcase locally.
Could be enhanced with explanation of the individual plugins and how they are architected.

Remove unnecessary dependencies

Changes

Remove unnecessary dependencies

  • check-dependency-version-consistency- No longer needed since we have the renovate bot

wip : Matrix of Streams & Days & Personas

/assign @schwesig

Idea:

  • create golden path per persona and area
  • stepping stones are the days in the matrix (rows are the deployment/ developing tiles)
  • each stepping stone will be at least one blog entry
  • each golden path blog links to the different blog entries in the right order, maybe with an intro/ tl;dr; and a connecting text part
    • therefore now blog is redundant

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

  • fix(deps): update all non-major dependencies (@docusaurus/core, @docusaurus/module-type-aliases, @docusaurus/plugin-google-gtag, @docusaurus/preset-classic, @docusaurus/theme-classic, @docusaurus/tsconfig, @docusaurus/types, @heroicons/react, @segment/analytics-next, @types/node, @types/react, @types/react-dom, autoprefixer, axios, clsx, framer-motion, lint-staged, node, pnpm, postcss, prettier-plugin-tailwindcss, react, react-cookie, react-dom, react-icons, tailwindcss, turbo, typescript)
  • fix(deps): update linters (@typescript-eslint/eslint-plugin, @typescript-eslint/parser, eslint, eslint-config-turbo, eslint-plugin-license-header, eslint-plugin-react, eslint-plugin-react-hooks, prettier)
  • chore(deps): update dependency husky to v9
  • chore(deps): update pnpm to v9
  • fix(deps): update linters (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser, eslint, eslint-config-airbnb-typescript, eslint-plugin-unicorn)
  • Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions
.github/workflows/ci.yaml
  • actions/checkout v4
  • actions/setup-node v4
.github/workflows/deploy-website.yaml
  • actions/checkout v4
  • actions/setup-node v4
  • actions/upload-pages-artifact v3
  • actions/deploy-pages v4
.github/workflows/on-new-issue.yaml
npm
apps/website/package.json
  • @docusaurus/core 3.1.1
  • @docusaurus/plugin-google-gtag 3.1.1
  • @docusaurus/preset-classic 3.1.1
  • @docusaurus/tsconfig 3.1.1
  • @mdx-js/react 3.0.1
  • clsx 2.1.0
  • docusaurus-plugin-remote-content 4.0.0
  • fuse.js 7.0.0
  • prism-react-renderer 2.3.1
  • react 18.2.0
  • react-cookie 7.1.0
  • react-dom 18.2.0
  • react-icons 5.0.1
  • use-query-params 2.2.1
  • @docusaurus/module-type-aliases 3.1.1
  • @docusaurus/theme-classic 3.1.1
  • @docusaurus/types 3.1.1
  • @types/node 20.11.20
  • @types/react 18.2.60
  • @types/react-dom 18.2.19
  • autoprefixer 10.4.17
  • deepmerge 4.3.1
  • dotenv 16.4.5
  • postcss 8.4.35
  • tailwindcss 3.4.1
  • typescript 5.3.3
  • node >=16.14
package.json
  • husky 8.0.3
  • lint-staged 15.2.2
  • prettier 3.2.4
  • prettier-plugin-tailwindcss 0.5.11
  • turbo 1.12.4
  • node >=18.0
  • pnpm 8.15.4
packages/docusaurus-plugin-tailwind/package.json
  • @docusaurus/types 3.1.1
  • @types/node 20.11.20
  • autoprefixer 10.4.17
  • eslint 8.56.0
  • tailwindcss 3.4.1
  • typescript 5.3.3
packages/eslint-config-custom/package.json
  • @typescript-eslint/eslint-plugin 6.19.1
  • @typescript-eslint/parser 6.19.1
  • eslint 8.56.0
  • eslint-config-airbnb 19.0.4
  • eslint-config-airbnb-typescript 17.1.0
  • eslint-config-prettier 9.1.0
  • eslint-config-turbo 1.11.3
  • eslint-plugin-eslint-comments 3.2.0
  • eslint-plugin-import 2.29.1
  • eslint-plugin-jsx-a11y 6.8.0
  • eslint-plugin-license-header 0.6.0
  • eslint-plugin-mdx 3.1.5
  • eslint-plugin-promise 6.1.1
  • eslint-plugin-react 7.33.2
  • eslint-plugin-react-hooks 4.6.0
  • eslint-plugin-typescript-enum 2.1.0
  • eslint-plugin-unicorn 50.0.1
  • typescript 5.3.3
packages/tsconfig/package.json
packages/ui/package.json
  • @heroicons/react 2.1.1
  • @radix-ui/react-dropdown-menu 2.0.6
  • @radix-ui/react-form 0.0.3
  • @radix-ui/react-tooltip 1.0.7
  • @segment/analytics-next 1.64.0
  • @tailwindcss/container-queries 0.1.1
  • clsx 2.1.0
  • deepmerge 4.3.1
  • framer-motion 11.0.6
  • fuse.js 7.0.0
  • react-cookie 7.1.0
  • react-icons 5.0.1
  • use-query-params 2.2.1
  • @types/react 18.2.60
  • @types/react-dom 18.2.19
  • autoprefixer 10.4.17
  • axios 1.6.7
  • eslint 8.56.0
  • postcss 8.4.35
  • react 18.2.0
  • react-dom 18.2.0
  • tailwindcss 3.4.1
  • typescript 5.3.3
nvm
.nvmrc
  • node 20.11.1

  • Check this box to trigger a request for Renovate to run again on this repository

Add git hooks

Add git hooks from janus-idp/backstage-showcase. Make sure the execute permission is set.

  • post-checkout
  • post-merge
  • post-rewrite

Add GPT Home Page to janus-idp.github.io

Description

Provide a GPTs Home page to the Janus community site to provide discovery of the details of a list of Sample GPTs which we have available.

Acceptance Criteria

The homepage should include the following:

  • Header containing:
    • Sample GPTs
    • Have a GPT idea?
    • Button -> Submit a proposal for a GPT!

The CTA should reference a new Issue template for the software templates repo similar to this plugin issue template

  • Search

    • Include a search field, but do not provide the filter dropdown as the Plugins page has
  • GPT Cards

    • Each card should contain:
      • Title
      • Description

Notes

  • GPTsList should include:
    • Title
    • Description
    • href
    • githubUrl

As a starter, include the following in the GPTs Home page:

https://github.com/janus-idp/software-templates/tree/main/scaffolder-templates/ansible-job
https://github.com/janus-idp/software-templates/tree/main/scaffolder-templates/quarkus-web-template
https://github.com/janus-idp/software-templates/tree/main/scaffolder-templates/documentation-template

Blocker

The following issue(s) will need to be completed before this issue can be started:

Precommit hook fails due to `lint:fix` not existing

Describe the bug

When trying to create a commit, the following error occurs:

> [email protected] lint-staged
> lint-staged

โœ” Preparing lint-staged...
โš  Running tasks for staged files...
  โฏ package.json โ€” 1 file
    โฏ * โ€” 1 file
      โœ– turbo run prettier:fix -- [KILLED]
    โฏ *.{js,jsx,ts,tsx,mjs,cjs} โ€” 1 file
      โœ– turbo run lint:fix -- [FAILED]
โ†“ Skipped because of errors from tasks.
โœ” Reverting to original state because of errors...
โœ” Cleaning up temporary files...

โœ– turbo run lint:fix --:
 ERROR  run failed: error preparing engine: Could not find the following tasks in project: lint:fix
Turbo error: error preparing engine: Could not find the following tasks in project: lint:fix

โœ– turbo run prettier:fix --:
โ€ข Packages in scope: //, docusaurus-plugin-tailwind, eslint-config-custom, tsconfig, ui, website
โ€ข Running prettier:fix in 6 packages
โ€ข Remote caching disabled
//:prettier:fix: cache bypass, force executing 0263fb2fa2ae5114
husky - pre-commit hook exited with code 1 (error)

Expected Behavior

The commit is created without error.

What are the steps to reproduce this bug?

  1. Create a commit with a modification for a file that is one of the following types ({js,jsx,ts,tsx,mjs,cjs})
  2. Observe above error

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.