Skip to content

Commit

Permalink
docs: changed header
Browse files Browse the repository at this point in the history
  • Loading branch information
dhrovat committed Sep 3, 2024
1 parent fee5e67 commit e19cdfe
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 25 deletions.
29 changes: 16 additions & 13 deletions docs/docs/migration-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h1 id="uof-net-sdk---migration-guide">UOF .NET SDK - Migration Guide</h1>
<p>No upgrades are planned for the nuget package Sportradar.OddsFeed.SDK in the future and customer solutions should be upgraded to use <code>Sportradar.OddsFeed.SDKCore</code>.</p>
<p>This is your roadmap to a smooth transition from your current SDK version to the latest version. The upgrade is designed to elevate your experience and align the SDK more closely with your business
needs.</p>
<h2 id="page-contents">Page Contents</h2>
<h3 id="page-contents">Page Contents</h3>
<ol>
<li>Upgrade Dependencies</li>
<li>Build new UofSdk instance</li>
Expand All @@ -118,7 +118,9 @@ <h2 id="page-contents">Page Contents</h2>
<li>Update the Documentation</li>
<li>Deploy to production</li>
<li>Monitoring and Maintenance</li>
<li>Feedback and Reporting</li>
<li>Feedback and Reporting
<br>
<br></li>
</ol>
<h2 id="here-are-the-general-steps-you-can-follow-to-complete-the-transition">Here are the general steps you can follow to complete the transition:</h2>
<h3 id="1-upgrade-dependencies">1. Upgrade Dependencies</h3>
Expand Down Expand Up @@ -179,7 +181,7 @@ <h3 id="3-update-the-methods-and-classes-in-your-code">3. Update the methods and
You can contact support if you
encounter specific issues.</p>
<p>The following classes and methods are changed. Hence, you will be needed to update your code to use new names.</p>
<h3 id="root-classes-renamed">Root Classes Renamed</h3>
<h4 id="root-classes-renamed">Root Classes Renamed</h4>
<ul>
<li>IOddsFeed to IUofSdk</li>
<li>IOddsFeedSession to IUofSession</li>
Expand All @@ -195,18 +197,18 @@ <h3 id="root-classes-renamed">Root Classes Renamed</h3>
<li>Renamed Feed.CreateBuilder() to UofSdk.GetSessionBuilder() for creating new IUofSession</li>
<li>config section moved to Sportradar.OddsFeed.SDK.Api.Internal.Config.UofConfigurationSection</li>
</ul>
<h3 id="removed-methods-and-classes">Removed methods and classes</h3>
<h4 id="removed-methods-and-classes">Removed methods and classes</h4>
<ul>
<li>IOutcomeSettlement.Result</li>
<li>IOddsFeedConfigurationSection.UseIntegrationEnvironment</li>
<li>IRound.GroupName</li>
<li>IRound.GetGroupName()</li>
</ul>
<h3 id="added-or-changed-methods">Added or changed methods</h3>
<h4 id="added-or-changed-methods">Added or changed methods</h4>
<ul>
<li>Added support for IVenue.Courses (returns list of ICourse instead of list of IHole)</li>
</ul>
<h3 id="enum-values-renamed-to-camelcase">Enum values renamed to CamelCase</h3>
<h4 id="enum-values-renamed-to-camelcase">Enum values renamed to CamelCase</h4>
<ul>
<li>MessageType</li>
<li>ExceptionHandlingStrategy</li>
Expand All @@ -217,13 +219,13 @@ <h3 id="enum-values-renamed-to-camelcase">Enum values renamed to CamelCase</h3>
<li>PropertyUsage</li>
<li>ResourceTypeGroup</li>
</ul>
<h3 id="changes-andor-new-features">Changes and/or new features</h3>
<h4 id="changes-andor-new-features">Changes and/or new features</h4>
<ul>
<li>Added support for IVenue.Courses (returns list of ICourse instead of list of IHole)</li>
<li>Added support for ICompetitor.Division - now contains division id and name (moved and replaced from ITeamCompetitor)</li>
<li>Extended IJersey with SquareColor and HorizontalStripesColor</li>
</ul>
<h3 id="name-changes">Name changes</h3>
<h4 id="name-changes">Name changes</h4>
<p>The following are changed to improve the consistency. Some classes were also moved to different namespace.</p>
<ul>
<li>URN -&gt; Urn</li>
Expand All @@ -235,7 +237,7 @@ <h3 id="name-changes">Name changes</h3>
<li>IRound.PhaseOrGroupLongName -&gt; PhaseOrGroupLongNames</li>
<li>IProducerManager.Get() -&gt; GetProducer()</li>
</ul>
<h3 id="changed-namespaces">Changed namespaces</h3>
<h4 id="changed-namespaces">Changed namespaces</h4>
<ul>
<li><code>API</code> namespace renamed to <code>Api</code></li>
<li><code>REST</code> namespace renamed to <code>Rest</code></li>
Expand All @@ -255,7 +257,7 @@ <h3 id="4-update-the-configuration">4. Update the Configuration</h3>
<li>just programmatically via IConfigurationBuilder</li>
</ol>
<p>Some of the options were removed from App.config section options and can only be configured via configuration builder.</p>
<h3 id="upgrade-configuration-in-appconfig">Upgrade configuration in App.config</h3>
<h4 id="upgrade-configuration-in-appconfig">Upgrade configuration in App.config</h4>
<p>Replace</p>
<pre><code class="lang-xml">&lt;configSections&gt;
&lt;section name=&quot;oddsFeedSection&quot; type=&quot;Sportradar.OddsFeed.SDK.API.Internal.OddsFeedConfigurationSection,Sportradar.OddsFeed.SDK&quot; /&gt;
Expand All @@ -266,7 +268,7 @@ <h3 id="upgrade-configuration-in-appconfig">Upgrade configuration in App.config<
&lt;section name=&quot;uofSdkSection&quot; type=&quot;Sportradar.OddsFeed.SDK.Api.Internal.Config.UofConfigurationSection,Sportradar.OddsFeed.SDK&quot; /&gt;
&lt;/configSections&gt;
</code></pre>
<h3 id="other-changes">Other changes</h3>
<h4 id="other-changes">Other changes</h4>
<p>You'll need to re-configure the following App.config configuration attributes.</p>
<table>
<thead>
Expand Down Expand Up @@ -364,9 +366,10 @@ <h3 id="other-changes">Other changes</h3>
</tr>
</tbody>
</table>
<h3 id="through-configurationbuilder">Through ConfigurationBuilder</h3>
<h4 id="through-configurationbuilder">Through ConfigurationBuilder</h4>
<p>The full configuration can be also setup via ConfigurationBuilder obtained via <code>UofSdk.GetUofConfigurationBuilder()</code>. The resulting
<code>IUofConfiguration</code> contains all the previously set configurations for the SDK.</p>
<code>IUofConfiguration</code> contains all the previously set configurations for the SDK.
<br><br></p>
<h3 id="5-test-your-project">5. Test your project</h3>
<p>Thoroughly test your project after making the changes. Test all critical functionality to ensure that everything still works as expected. Pay special attention to any areas of your setup that interact
with the sdk, as these are likely to be the most affected by the upgrade.</p>
Expand Down
Binary file modified docs/docs/toc.pdf
Binary file not shown.
Binary file modified docs/sdkapi/toc.pdf
Binary file not shown.
15 changes: 4 additions & 11 deletions docs/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,10 @@

<ul class="nav level1">
<li>
<span class="expand-stub"></span>
<a href="index.html" name="" title="API Reference">API Reference</a>

<ul class="nav level2">
<li>
<a href="docs/introduction.html" name="docs/toc.html" title="Docs">Docs</a>
</li>
<li>
<a href="sdkapi/Sportradar.OddsFeed.SDK.Api.html" name="sdkapi/toc.html" title="API">API</a>
</li>
</ul>
<a href="docs/introduction.html" name="docs/toc.html" title="Docs">Docs</a>
</li>
<li>
<a href="sdkapi/Sportradar.OddsFeed.SDK.Api.html" name="sdkapi/toc.html" title="API">API</a>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/toc.json
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

{"items":[{"name":"API Reference","href":"index.html","topicHref":"index.html","items":[{"name":"Docs","href":"docs/introduction.html","tocHref":"docs/toc.html","topicHref":"docs/introduction.html"},{"name":"API","href":"sdkapi/Sportradar.OddsFeed.SDK.Api.html","tocHref":"sdkapi/toc.html","topicHref":"sdkapi/Sportradar.OddsFeed.SDK.Api.html","topicUid":"Sportradar.OddsFeed.SDK.Api"}]}],"pdf":true}
{"items":[{"name":"Docs","href":"docs/introduction.html","tocHref":"docs/toc.html","topicHref":"docs/introduction.html"},{"name":"API","href":"sdkapi/Sportradar.OddsFeed.SDK.Api.html","tocHref":"sdkapi/toc.html","topicHref":"sdkapi/Sportradar.OddsFeed.SDK.Api.html","topicUid":"Sportradar.OddsFeed.SDK.Api"}],"pdf":true}
Binary file modified docs/toc.pdf
Binary file not shown.

0 comments on commit e19cdfe

Please sign in to comment.