Git Product home page Git Product logo

microcks.io's Introduction

GitHub Workflow Status Container Version License Project Chat Artifact HUB CNCF Landscape

Microcks - Kubernetes native tool for API Mocking & Testing

Microcks is a platform for turning your API and microservices assets - OpenAPI specs, AsyncAPI specs, gRPC protobuf, GraphQL schema, Postman collections, SoapUI projects - into live mocks in seconds.

It also reuses these assets for running compliance and non-regression tests against your API implementation. We provide integrations with Jenkins, GitHub Actions, Tekton and many others through a simple CLI.

Getting Started

To get involved with our community, please make sure you are familiar with the project's Code of Conduct.

Build Status

The current development version is 1.10.1-SNAPSHOT.

GitHub Workflow Status

Sonarcloud Quality metrics

Code Smells Reliability Rating Bugs Coverage Technical Debt Security Rating Maintainability Rating

Fossa license and security scans

FOSSA Status FOSSA Status FOSSA Status

OpenSSF best practices

CII Best Practices OpenSSF Scorecard

Versions

Here are the naming conventions we're using for current releases, ongoing development maintenance activities.

Status Version Branch Container images tags
Stable 1.10.0 master 1.10.0, latest
Dev 1.10.1-SNAPSHOT 1.10.x nightly
Maintenance 1.9.2-SNAPSHOT 1.9.x maintenance

How to build Microcks

The build instructions are available in the contribution guide.

Thanks to community!

Stargazers repo roster for @microcks/microcks Forkers repo roster for @microcks/microcks

microcks.io's People

Contributors

arhell avatar aygalinc avatar azplanlos avatar bodograumann avatar btison avatar dalelane avatar damounet avatar gonmmarques avatar graydo64 avatar hguerrero avatar hodrigohamalho avatar imod avatar julienbreux avatar kengneruphine avatar lbroudoux avatar narioinc avatar nmasse-itix avatar philsturgeon avatar pmamico avatar sfraigneau avatar sogit avatar vishalmgada avatar wengkee avatar yada avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

microcks.io's Issues

Left side navigation broken layout

Describe the bug

As a user I want to be able to see left side navigation content without scrolling whole page to the end.

Also left side navigation content overlaps next section content on screens with width <= 1560px
image

Expected behavior

  • Left side navigation does not overlay bottom's content
  • Content from left side navigation available without scrolling the whole page

Actual behavior

  • Left side navigation overlay bottom's content
  • User can not see left side navigation content without scrolling to the page end (if left side navigation content is bigger than view height)
Screen.Recording.2024-05-02.at.16.04.06.mov

How to Reproduce?

Open https://microcks.io/documentation/using/openapi/

Microcks version or git rev

No response

Install method (docker-compose, helm chart, operator, docker-desktop extension,...)

No response

Additional information

No response

External Link Check Refactor Doc Report - Tuesday, 21. May 2024

Summary

Status Count
๐Ÿ” Total 1532
โœ… Successful 1127
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 5
๐Ÿšซ Errors 41

Errors per input

Errors in themes/microcks/layouts/career/single.html

Errors in content/events/PastArchive.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/documentation/archive/using/postman.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

External Link Check Refactor Doc Report - Tuesday, 14. May 2024

Summary

Status Count
๐Ÿ” Total 1505
โœ… Successful 1090
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 327
โ“ Unknown 7
๐Ÿšซ Errors 78

Errors per input

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/continuous-testing-all-your-apis.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/community/_index.md

Errors in content/blog/microcks-1.5.2-release.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/events/PastArchive.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/documentation/archive/using/postman.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/advanced-dispatching-constraints.md

External Link Check Refactor Doc Report - Monday, 20. May 2024

Summary

Status Count
๐Ÿ” Total 1532
โœ… Successful 1112
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 5
๐Ÿšซ Errors 56

Errors per input

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/events/PastArchive.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/documentation/archive/installing/running-uber.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/documentation/archive/using/openapi.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/blog/microcks-1.0.0-release.md

External Link Check Refactor Doc Report - Sunday, 19. May 2024

Summary

Status Count
๐Ÿ” Total 1532
โœ… Successful 1115
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 5
๐Ÿšซ Errors 53

Errors per input

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/documentation/archive/installing/running-uber.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-on-kind.md

Errors in content/events/MWCFeb2024.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/events/PastArchive.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/microcks-1.2.1-release.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/apache-kafka-mocking-testing.md

External Link Check Refactor Doc Report - Wednesday, 15. May 2024

Summary

Status Count
๐Ÿ” Total 1511
โœ… Successful 1086
โณ Timeouts 0
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 358
โ“ Unknown 4
๐Ÿšซ Errors 63

Errors per input

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/events/PastArchive.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/author/hugo-guerrero.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-1.5.2-release.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/documentation/archive/installing/running-uber.md

Errors in content/blog/microcks-on-kind.md

Errors in content/author/nicolas-masse.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/microcks-1.5.0-release.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/microcks-1.2.0-release.md

https://microcks.io/discord-invite (social footer icon) is not working

Describe the bug

In params.toml

[[social]]
title = "Discord"
icon = "fab fa-discord" # themify icon : https://themify.me/themify-icons
link = "https://microcks.io/discord-invite"

But this redirect (in discord-invite/_index.md) is not working:

---
title: "Microcks Discord Invite"
layout: "redirect"
target: "https://discord.gg/JA4rbcGzk7"
---

Expected behavior

Should redirect to https://discord.gg/JA4rbcGzk7

Actual behavior

No redirection and blank page:
Capture dโ€™eฬcran 2024-02-03 aฬ€ 18 26 06

How to Reproduce?

Just click here: https://microcks.io/discord-invite/

Microcks version or git rev

No response

Install method (docker-compose, helm chart, operator, docker-desktop extension,...)

No response

Additional information

I can easily do a PR on this and:

  1. delete "discord-invite/_index.md"
  2. replace "https://microcks.io/discord-invite" with "https://discord.gg/JA4rbcGzk7" in params.toml

GitHub Action to verify build integrity with every push (commit) made to the Microcks website.

Reason/Context

We need to enhance our GitHub Actions to ensure that build errors are checked with every push (commit) made to the Microcks website. This improvement is essential for maintaining the integrity and reliability of our website.

By incorporating this improvement, contributors can promptly identify and address any build errors during development. This proactive (using the latest Hugo version) approach will help us maintain a stable, error-free website, enhancing user and contributor experience.

Description

The feature entails adding a GitHub Action that checks for build errors on each push (commit) to the Microcks website repository. This action will trigger automatically whenever a new commit is pushed, allowing contributors to detect and handle any build errors promptly.

Implementation ideas

This GitHub Action builds and serves a Hugo website, checking for build errors (always using the latest Hugo version) on each push to the master branch. The build status is checked, and if the build fails, the commit is blocked.

CNCF logo overlaps text

Describe the bug

There is an overlap of the CNCF logo and the text of getting started in the main page

image

Expected behavior

No response

Actual behavior

No response

How to Reproduce?

No response

Microcks version or git rev

No response

Install method (docker-compose, helm chart, operator, docker-desktop extension,...)

No response

Additional information

No response

External Link Check Refactor Doc Report - Wednesday, 15. May 2024

Summary

Status Count
๐Ÿ” Total 1505
โœ… Successful 1082
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 327
โ“ Unknown 7
๐Ÿšซ Errors 86

Errors per input

Errors in content/community/_index.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/continuous-testing-all-your-apis.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-1.3.0-release.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/documentation/archive/installing/running-uber.md

Errors in content/author/hugo-guerrero.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/events/PastArchive.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/author/nicolas-masse.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/microcks-1.5.2-release.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/events/DevoxxFR2023.md

External Link Check Refactor Doc Report - Thursday, 30. May 2024

Summary

Status Count
๐Ÿ” Total 1528
โœ… Successful 1135
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 344
โ“ Unknown 5
๐Ÿšซ Errors 41

Errors per input

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/documentation/references/artifacts/graphql-conventions.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/documentation/archive/installing/running-uber.md

Errors in content/events/PastArchive.md

External Link Check Refactor Doc Report - Thursday, 16. May 2024

Summary

Status Count
๐Ÿ” Total 1506
โœ… Successful 1104
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 345
โ“ Unknown 5
๐Ÿšซ Errors 49

Errors per input

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-1.5.0-release.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/author/yacine-kheddache.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/events/PastArchive.md

Errors in content/blog/microcks-1.5.2-release.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/documentation/archive/using/postman.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

External Link Check Refactor Doc Report - Saturday, 18. May 2024

Summary

Status Count
๐Ÿ” Total 1532
โœ… Successful 1124
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 5
๐Ÿšซ Errors 44

Errors per input

Errors in content/blog/microcks-hub-announcement.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/microcks-1.5.0-release.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/microcks-on-kind.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/events/DevoxxFR2023.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/events/PastArchive.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/graphql-features-what-to-expect.md

Add https://www.linkedin.com/in/madihar/ to .lycheeignore as url is OK, remove linkedin rate limit error

Describe the bug

As reported in issue #100
"
Errors in content/blog/microcks-1.5.0-release.md
[429] https://www.linkedin.com/in/madihar/ | Failed: Network error: Too Many Requests
"

This is the typical LinkedIn rate limit. Following the instructions on #100 comment:
"
.../...
Verify Links: If you encounter rate limit errors for LinkedIn or GitHub profiles, click on the link, verify its accuracy, and update the .lycheeignore file accordingly to prevent future error reporting.
.../...
"

I have checked, and the URL is correct; a profile is available for https://www.linkedin.com/in/madihar/ (Madiha Rehman) so we can create a PR to add this URL in .lycheeignore to acknowledge this error and remove it (exclude/ignore) from following reporting.

Attach any resources that can help us understand the issue.

No response

Allow adding co-authors to a blog post

Reason/Context

As of today, a blog post a just one author.

Description

We'd like to have the possibility to have co-authors.

Implementation ideas

No response

External Link Check Refactor Doc Report - Wednesday, 29. May 2024

Summary

Status Count
๐Ÿ” Total 1528
โœ… Successful 1130
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 344
โ“ Unknown 3
๐Ÿšซ Errors 48

Errors per input

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/documentation/archive/using/postman.md

Errors in content/documentation/references/artifacts/graphql-conventions.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/author/alain-pham.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/author/hugo-guerrero.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/author/carol-gschwend.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/events/PastArchive.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/author/laurent-broudoux.md

Errors in content/blog/microcks-1.7.0-release.md

Improve the jenkins plugin documentation

The documentation about the jenkins plugin (https://microcks.io/documentation/automating/jenkins/) gives the command to create the build config but does not explain how to use the resulting image in jenkins.

The following two commands update an jenkins deploymentconfig to use the custom image:

oc set triggers dc/jenkins --remove --from-image=openshift/jenkins:2
oc set triggers dc/jenkins --from-image=microcks-jenkins-master:latest -c jenkins

Setup new documentation organization

Put the new organization in place, as discussed in #81.
All the existing documentation will be moved under an Archive section, at the very bottom of the main menu, just during the migration process. Once the Archive section will be empty, we'll be ready to move on and replace existing website with re-organized documentation.

This is a part of #81

External Link Check Refactor Doc Report - Sunday, 26. May 2024

Summary

Status Count
๐Ÿ” Total 1542
โœ… Successful 1135
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 5
๐Ÿšซ Errors 43

Errors per input

Errors in content/events/DevoxxFR2023.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/documentation/archive/using/postman.md

Errors in content/events/PastArchive.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/microcks-1.0.0-release.md

Add link checker for Microcks website

Reason/Context

Adding a link checker will help to ensure that our website remains user-friendly, search engine optimized, and better maintained.

Description

Add auto checks and reporting using GitHub actions, ideally to create issue and/or markdown reporting and why not (later and after cleanup) on each commit or new PR to enforce it...

Implementation ideas

WIP using Lychee and https://github.com/lycheeverse/lychee-action/

External Link Check Refactor Doc Report - Saturday, 25. May 2024

Summary

Status Count
๐Ÿ” Total 1542
โœ… Successful 1122
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 4
๐Ÿšซ Errors 57

Errors per input

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/events/PastArchive.md

Errors in content/events/DevoxxFR2023.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-on-kind.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/author/hugo-guerrero.md

External Link Check Refactor Doc Report - Friday, 24. May 2024

Summary

Status Count
๐Ÿ” Total 1536
โœ… Successful 1117
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 357
โ“ Unknown 3
๐Ÿšซ Errors 56

Errors per input

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/author/alain-pham.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/author/laurent-broudoux.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/author/nicolas-masse.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/events/PastArchive.md

Errors in content/author/yacine-kheddache.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/blog/microcks-1.4.1-release.md

External Link Check Refactor Doc Report - Tuesday, 28. May 2024

Summary

Status Count
๐Ÿ” Total 1531
โœ… Successful 1125
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 346
โ“ Unknown 5
๐Ÿšซ Errors 52

Errors per input

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-1.5.0-release.md

Errors in content/documentation/archive/using/postman.md

Errors in content/events/DevoxxFR2023.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/events/PastArchive.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/author/laurent-broudoux.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/blog/microcks-on-kind.md

Errors in content/documentation/references/artifacts/graphql-conventions.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/author/hugo-guerrero.md

Errors in content/documentation/archive/installing/deployment-options.md

External Link Check Refactor Doc Report - Thursday, 23. May 2024

Summary

Status Count
๐Ÿ” Total 1532
โœ… Successful 1116
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 4
๐Ÿšซ Errors 53

Errors per input

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/author/sebastien-fraigneau.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/author/hugo-guerrero.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-on-kind.md

Errors in content/events/PastArchive.md

Errors in content/blog/microcks-1.5.1-release.md

External Link Check Refactor Doc Report - Wednesday, 15. May 2024

Summary

Status Count
๐Ÿ” Total 1505
โœ… Successful 1082
โณ Timeouts 0
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 327
โ“ Unknown 3
๐Ÿšซ Errors 93

Errors per input

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/author/hugo-guerrero.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/author/sebastien-fraigneau.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/author/nicolas-masse.md

Errors in content/events/PastArchive.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-1.5.0-release.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-1.3.0-release.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/microcks-1.5.2-release.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/continuous-testing-all-your-apis.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/community/_index.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/documentation/archive/installing/running-uber.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Refactor documentation content organization

The documentation content, a crucial resource for our organization, is currently disorganized and can pose a challenge for new team members to navigate...
As part of a first brainstorming session between core maintainers, we come with the following wrap-up:

๐Ÿ˜ค Todayโ€™s pains

  • โ€œGetting startedโ€ is too longโ€ฆ
  • Guides take a lot of time to write
  • Short explanations (โ€œHow to install onโ€ฆโ€) are published as blog posts
  • Donโ€™t have space/room for short how-toโ€™s
  • Too few contributions on โ€œHow to install on..โ€, โ€œHow to setupโ€ฆโ€
  • Missing documentation because of questioning
    • Where to put the AI stuff? In Using? Installing? Automating?
    • Where to put the Backstage stuff?
  • Configuration references and explanations (Helm values โ‡” application.properties matching)

๐ŸŽฏ Our goals

  • Have a place for short publications
  • Favor external contributions on task oriented stuff (โ€œHow toโ€ฆโ€)
  • Being able to cover the whole โ€œlifecycleโ€ of a feature:
    • From teasing to using to explaining all the bits and bytes
  • Having guidelines for easier writing and allocation of pieces of docs
  • Having comprehensive reference on:
    • Container images with their options
    • Configuration properties
    • Commands
    • APIs

๐Ÿ’ก Ideas

  • We started to review successful other projects documentation to check how they have the doc organized
    • Started reviews on istio.io, keycloak.org, backstage.io
  • We started to look at some documentation methodology like Diataxis
  • Reviewed some other project's doc that follows Diataxis principles like djangoproject.com or loopback.io
    • Have to say we like those ideas so far ๐Ÿ˜‰
  • We started to project some refactoring using this method and will share it very soon.

๐Ÿค” Refactoring concerns

  • How to adopt a standard organization that makes users happy and the project successful?
  • How to avoid broken links?
  • How to manage transition if we have to move pages?
  • How to connect the help system within Microcks UI?

Please don't feel intimidated, as this task of documentation refactoring can look huge from the outside. We're definitely looking forward to hearing from you!!

This is an ongoing effort as discussed on our Discord server here: https://discord.com/channels/1162356525969449100/1234906549844185139/1234906550787641496

External Link Check Refactor Doc Report - Wednesday, 22. May 2024

Summary

Status Count
๐Ÿ” Total 1532
โœ… Successful 1121
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 5
๐Ÿšซ Errors 47

Errors per input

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/documentation/archive/using/postman.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/author/alain-pham.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/events/PastArchive.md

Errors in content/events/DevoxxFR2023.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/author/laurent-broudoux.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/blog/microcks-1.0.0-release.md

External Link Check Refactor Doc Report - Monday, 27. May 2024

Summary

Status Count
๐Ÿ” Total 1542
โœ… Successful 1131
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 2
๐Ÿšซ Errors 50

Errors per input

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/author/alain-pham.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/events/PastArchive.md

Errors in content/blog/microcks-on-minikube.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/author/carol-gschwend.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/documentation/archive/using/grpc.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/author/sebastien-fraigneau.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/microcks-1.7.0-release.md

External Link Check Refactor Doc Report - Friday, 31. May 2024

Summary

Status Count
๐Ÿ” Total 1528
โœ… Successful 1126
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 344
โ“ Unknown 3
๐Ÿšซ Errors 52

Errors per input

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/author/hugo-guerrero.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/documentation/archive/using/postman.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/author/laurent-broudoux.md

Errors in content/events/PastArchive.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/author/sebastien-fraigneau.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/blog/microcks-on-kind.md

Errors in content/documentation/references/artifacts/graphql-conventions.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/author/alain-pham.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/events/DevoxxFR2023.md

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/microcks-1.5.0-release.md

Errors in content/author/yacine-kheddache.md

Errors in content/blog/microcks-1.8.0-release.md

External Link Check Refactor Doc Report - Friday, 17. May 2024

Summary

Status Count
๐Ÿ” Total 1532
โœ… Successful 1114
โณ Timeouts 3
๐Ÿ”€ Redirected 0
๐Ÿ‘ป Excluded 356
โ“ Unknown 4
๐Ÿšซ Errors 55

Errors per input

Errors in content/blog/microcks-1.6.0-release.md

Errors in content/blog/microcks-1.4.1-release.md

Errors in content/blog/microcks-1.0.0-release.md

Errors in content/blog/microcks-on-kind.md

Errors in content/blog/microcks-1.8.0-release.md

Errors in content/documentation/archive/installing/deployment-options.md

Errors in content/blog/advanced-dispatching-constraints.md

Errors in content/author/alain-pham.md

Errors in content/documentation/archive/using/postman.md

Errors in content/documentation/archive/using/openapi.md

Errors in content/blog/microcks-1.9.0-release.md

Errors in content/blog/microcks-on-minikube.md

Errors in content/blog/graphql-features-what-to-expect.md

Errors in content/blog/microcks-1.7.1-release.md

Errors in content/blog/microcks-joining-cncf-sandbox.md

Errors in content/blog/extend-microcks-with-custom-libs.md

Errors in content/blog/simulating-cloudevents-with-asyncapi.md

Errors in content/events/PastArchive.md

Errors in content/documentation/archive/using/graphql.md

Errors in content/blog/microcks-1.5.1-release.md

Errors in content/blog/microcks-1.8.1-release.md

Errors in content/blog/apache-kafka-mocking-testing.md

Errors in content/blog/microcks-hub-announcement.md

Errors in content/blog/microcks-1.2.1-release.md

Errors in content/events/DevoxxFR2023.md

Errors in themes/microcks/layouts/career/single.html

Errors in content/blog/microcks-1.2.0-release.md

Errors in content/documentation/archive/installing/running-uber.md

Errors in content/blog/microcks-0.9.0-release.md

Errors in content/blog/microcks-1.7.0-release.md

Errors in content/documentation/archive/using/grpc.md

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.