Skip to content

Commit

Permalink
Fix minor SDK reference-related issues (#488)
Browse files Browse the repository at this point in the history
* Fix NuGet badge + schema reference

* Fix broken/wrong links in SDK reference schemas
  • Loading branch information
adams85 authored Sep 19, 2024
1 parent fc43743 commit 93ffaa1
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 18 deletions.
5 changes: 3 additions & 2 deletions website/docs/sdk-reference/dotnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
export const NetSchema = require('@site/src/schema-markup/sdk-reference/net.json');

<script type='application/ld+json' dangerouslySetInnerHTML={ { __html: JSON.stringify(NetSchema) }}></script>
<script type='application/ld+json' dangerouslySetInnerHTML={{ __html: JSON.stringify(NetSchema) }}></script>

[![Star on GitHub](https://img.shields.io/github/stars/configcat/.net-sdk.svg?style=social)](https://github.com/configcat/.net-sdk/stargazers)
[![Build status](https://ci.appveyor.com/api/projects/status/3kygp783vc2uv9xr?svg=true)](https://ci.appveyor.com/project/ConfigCat/net-sdk) [![NuGet Version](https://buildstats.info/nuget/ConfigCat.Client)](https://www.nuget.org/packages/ConfigCat.Client/)
[![Build status](https://ci.appveyor.com/api/projects/status/3kygp783vc2uv9xr?svg=true)](https://ci.appveyor.com/project/ConfigCat/net-sdk)
[![NuGet Version](https://img.shields.io/nuget/v/ConfigCat.Client)](https://www.nuget.org/packages/ConfigCat.Client/)
[![Sonar Coverage](https://img.shields.io/sonar/coverage/net-sdk?logo=SonarCloud&server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/project/overview?id=net-sdk)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=net-sdk&metric=alert_status)](https://sonarcloud.io/dashboard?id=net-sdk)

Expand Down
2 changes: 1 addition & 1 deletion website/src/schema-markup/sdk-reference/java.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"text": "Get your setting value",
"image": "https://configcat.com/images/shared/home.png",
"name": "Evaluation",
"url": "https://configcat.com/docs/sdk-reference/java/#3-create-and-get-the-configcat-client-for-your-sdk-key"
"url": "https://configcat.com/docs/sdk-reference/java/#4-get-your-setting-value"
},{
"@type": "HowToStep",
"text": "Stop ConfigCat client",
Expand Down
2 changes: 1 addition & 1 deletion website/src/schema-markup/sdk-reference/js-ssr.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"text": "Dispose ConfigCat client",
"image": "https://configcat.com/images/shared/home.png",
"name": "Dispose",
"url": "https://configcat.com/docs/sdk-reference/js-ssr/#4-dispose-configcat-client"
"url": "https://configcat.com/docs/sdk-reference/js-ssr/#4-dispose-the-configcat-client"
}
]
}
2 changes: 1 addition & 1 deletion website/src/schema-markup/sdk-reference/js.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"text": "Dispose ConfigCat client",
"image": "https://configcat.com/images/shared/home.png",
"name": "Dispose",
"url": "https://configcat.com/docs/sdk-reference/js/#4-dispose-configcat-client"
"url": "https://configcat.com/docs/sdk-reference/js/#4-dispose-the-configcat-client"
}
]
}
6 changes: 3 additions & 3 deletions website/src/schema-markup/sdk-reference/net.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"@context": "https://schema.org/",
"@type": "HowTo",
"name": "How to use feature flags in .NET, .NET Core, C#?",
"description": "How to use feature flags in .NET, .NET Core, C# using ConfigCat Feature Flags. https://configcat.com",
"name": "How to use feature flags in .NET and C#?",
"description": "How to use feature flags in .NET and C# using ConfigCat Feature Flags. https://configcat.com",
"image": "https://configcat.com/images/shared/home.png",
"totalTime": "PT10M",
"estimatedCost": {
Expand Down Expand Up @@ -60,7 +60,7 @@
"@type": "HowToStep",
"text": "Dispose ConfigCat client",
"name": "Dispose",
"url": "https://configcat.com/docs/sdk-reference/dotnet/#5-dispose-configcat-client",
"url": "https://configcat.com/docs/sdk-reference/dotnet/#5-dispose-the-configcat-client",
"image": "https://configcat.com/images/shared/home.png"
}
]
Expand Down
2 changes: 1 addition & 1 deletion website/src/schema-markup/sdk-reference/node.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"text": "Dispose ConfigCat client",
"image": "https://configcat.com/images/shared/home.png",
"name": "Dispose",
"url": "https://configcat.com/docs/sdk-reference/node/#5-dispose-configcat-client"
"url": "https://configcat.com/docs/sdk-reference/node/#5-dispose-the-configcat-client"
}
]
}
7 changes: 0 additions & 7 deletions website/src/schema-markup/sdk-reference/react.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,6 @@
"name": "Installation",
"url": "https://configcat.com/docs/sdk-reference/react/#1-install-package"
},
{
"@type": "HowToStep",
"text": "Import the package",
"image": "https://configcat.com/images/shared/home.png",
"name": "Import",
"url": "https://configcat.com/docs/sdk-reference/python/#2-import-the-package"
},
{
"@type": "HowToStep",
"text": "Import and initialize a ConfigCatProvider with your SDK Key",
Expand Down
5 changes: 3 additions & 2 deletions website/versioned_docs/version-V1/sdk-reference/dotnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
export const NetSchema = require('@site/src/schema-markup/sdk-reference/net.json');

<script type='application/ld+json' dangerouslySetInnerHTML={ { __html: JSON.stringify(NetSchema) }}></script>
<script type='application/ld+json' dangerouslySetInnerHTML={{ __html: JSON.stringify(NetSchema) }}></script>

[![Star on GitHub](https://img.shields.io/github/stars/configcat/.net-sdk.svg?style=social)](https://github.com/configcat/.net-sdk/stargazers)
[![Build status](https://ci.appveyor.com/api/projects/status/3kygp783vc2uv9xr?svg=true)](https://ci.appveyor.com/project/ConfigCat/net-sdk) [![NuGet Version](https://buildstats.info/nuget/ConfigCat.Client)](https://www.nuget.org/packages/ConfigCat.Client/)
[![Build status](https://ci.appveyor.com/api/projects/status/3kygp783vc2uv9xr?svg=true)](https://ci.appveyor.com/project/ConfigCat/net-sdk)
[![NuGet Version](https://img.shields.io/nuget/v/ConfigCat.Client)](https://www.nuget.org/packages/ConfigCat.Client/)
[![Sonar Coverage](https://img.shields.io/sonar/coverage/net-sdk?logo=SonarCloud&server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/project/overview?id=net-sdk)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=net-sdk&metric=alert_status)](https://sonarcloud.io/dashboard?id=net-sdk)

Expand Down

0 comments on commit 93ffaa1

Please sign in to comment.