Skip to content

Commit

Permalink
Update generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jul 2, 2024
1 parent 26cc9e3 commit 0035915
Show file tree
Hide file tree
Showing 8 changed files with 198 additions and 17 deletions.
2 changes: 1 addition & 1 deletion apiconcepts/Tridion_Docs_14SP3/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h2 id="content-manager-apihttpsdocsrwscom806356604329sdl-tridion-docs-14-sp3con
<p>Only described API classes and functions are supported and can be used. Do not use any other API function because they are subject to change.</p>
<h2 id="powershell-modules">PowerShell modules</h2>
<h3 id="ishdeployhttpsrwsgithubioishdeploy"><a href="https://rws.github.io/ISHDeploy/">ISHDeploy</a></h3>
<p>ISHDeploy is a PowerShell module that enables the code-as-configuration concept for Tridion Docs, starting from version 13.0.0 including 14.0.3.</p>
<p>ISHDeploy is a PowerShell module that enables the code-as-configuration concept for Tridion Docs, starting from version 13.0.0, up to and including 15.1.0.</p>
<h3 id="ishremotehttpsgithubcomrwsishremote"><a href="https://github.com/RWS/ISHRemote">ISHRemote</a></h3>
<p>ISHRemote is a PowerShell module on top of Tridion Docs Content Manager. Its goal is business automation on top of the Component Content Management System.</p>
<h3 id="ishserverhttpsgithubcomrwsishserver"><a href="https://github.com/RWS/ISHServer">ISHServer</a></h3>
Expand Down
2 changes: 1 addition & 1 deletion apiconcepts/Tridion_Docs_14SP4/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h2 id="content-manager-apihttpsdocsrwscom99251375782tridion-docs-14-sp4content-
<p>Only described API classes and functions are supported and can be used. Do not use any other API function because they are subject to change.</p>
<h2 id="powershell-modules">PowerShell modules</h2>
<h3 id="ishdeployhttpsdocsrwscomishdeploy"><a href="https://docs.rws.com/ISHDeploy/">ISHDeploy</a></h3>
<p>ISHDeploy is a PowerShell module that enables the code-as-configuration concept for Tridion Docs, starting from version 13.0.0 including 14.0.4.</p>
<p>ISHDeploy is a PowerShell module that enables the code-as-configuration concept for Tridion Docs, starting from version 13.0.0, up to and including 15.1.0.</p>
<h3 id="ishremotehttpsgithubcomrwsishremote"><a href="https://github.com/RWS/ISHRemote">ISHRemote</a></h3>
<p>ISHRemote is a PowerShell module on top of Tridion Docs Content Manager. Its goal is business automation on top of the Component Content Management System.</p>
<h3 id="ishserverhttpsgithubcomrwsishserver"><a href="https://github.com/RWS/ISHServer">ISHServer</a></h3>
Expand Down
159 changes: 159 additions & 0 deletions apiconcepts/Tridion_Docs_15.1/overview.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Tridion Docs API Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Tridion Docs API Documentation ">
<meta name="generator" content="docfx 2.59.3.0">

<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="../toc.html">

<meta property="docfx:rel" content="../../">

</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="/index.html">
<img id="logo" class="svg" src="../../logo.svg" alt="">
</a>
<a href="/index.html"><span class="page-logo">Developers</span></a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<span class="glyphicon glyphicon-search search-icon"></span>
<input type="text" class="form-control" id="search-query" placeholder="" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar-default">
<div class="container hide-when-search">
<div class="breadcrumb-container" id="breadcrumb">
<ul class="breadcrumb col-md-10">
<li></li>
</ul>
</div>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list"> <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="data-prev=" data-next="data-last="></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle"></a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="tridion-docs-api-documentation">Tridion Docs API Documentation</h1>

<h2 id="content-manager-web-services-apihttpsdocsrwscomtridiondocs151webservicesapi"><a href="https://docs.rws.com/TridionDocs15.1/WebServicesAPI">Content Manager Web Services API</a></h2>
<p>This section contains information for developers to develop applications on top of the Content Manager Web Services API.</p>
<p>You can only use the API classes and functions that are available from this page. Any other API functions are subject to change and not supported externally, so you should not use them.</p>
<h2 id="powershell-modules">PowerShell modules</h2>
<h3 id="ishdeployhttpsdocsrwscomtridiondocs151ishdeploy"><a href="https://docs.rws.com/TridionDocs15.1/ISHDeploy/">ISHDeploy</a></h3>
<p>ISHDeploy is a PowerShell module that enables the code-as-configuration concept for Tridion Docs, starting from version 13.0.0, up to and including 15.1.0.</p>
<h3 id="ishremotehttpsgithubcomrwsishremote"><a href="https://github.com/RWS/ISHRemote">ISHRemote</a></h3>
<p>ISHRemote is a PowerShell module on top of Tridion Docs Content Manager. Its goal is business automation on top of the Component Content Management System.</p>
<h3 id="ishserverhttpsgithubcomrwsishserver"><a href="https://github.com/RWS/ISHServer">ISHServer</a></h3>
<p>ISHServer is a PowerShell module to help automate installation of prerequisites for Tridion Docs.</p>
<h3 id="ishbootstraphttpsgithubcomrwsishbootstrap"><a href="https://github.com/RWS/ISHBootstrap">ISHBootstrap</a></h3>
<p>ISHBootstrap is a bootstrapper for deployments of Tridion Docs Content Manager.</p>
<h2 id="tridion-dxa">Tridion DXA</h2>
<p>This section is intended for developers wanting to extend DXA functionality using its open-source .NET and Java APIs.</p>
<h3 id="customizing-and-extending-dxa">Customizing and extending DXA</h3>
<p><a href="https://docs.rws.com/784837/720093/sdl-digital-experience-accelerator-2-2/development-prerequisites">Development prerequisites</a>
Developing custom Tridion Sites web applications/sites requires a full development environment. The necessary third-party software differs depending on whether you are developing a .NET or Java application.</p>
<p><a href="https://docs.rws.com/784837/682805/sdl-digital-experience-accelerator-2-2/-net-web-application-development">.NET web application development</a>
Set up a .NET development environment to customize or extend the DXA .NET web application.</p>
<p><a href="https://docs.rws.com/784837/720545/sdl-digital-experience-accelerator-2-2/java-web-application-development">Java web application development</a>
Set up a Java development environment to customize or extend the DXA Java web application.</p>
<p><a href="https://docs.rws.com/784837/679912/sdl-digital-experience-accelerator-2-2/using-sdl-s-public-apis">Using RWS&#39;s public APIs</a>
Use the available public APIs to extend and customize the behavior of DXA.</p>
<p><a href="https://docs.rws.com/784837/651695/sdl-digital-experience-accelerator-2-2/creating-the-folder-structure-for-a-custom-module">Creating the folder structure for a custom module</a>
A custom module implements a distinct piece of functionality that is only relevant to some implementations. When you want to add a module to DXA, you need to create a folder structure in Content Manager.</p>
<p><a href="https://docs.rws.com/784837/695734/sdl-digital-experience-accelerator-2-2/model-mapping-and-semantics">Model mapping and semantics</a>
Domain (Content Manager) Models are mapped to the Presentation (View) Models using Model Semantics so that web developers can work with data structures optimized for the Views they are creating without having to have a deep understanding of the underlying content model.</p>
<h3 id="api-reference-documentation-downloads">API reference documentation downloads</h3>
<p>Links to download the API reference documentation for DXA.</p>
<ul>
<li><a href="https://docs.sdl.com/DXA/DotNET/2.2/APIDOC/">DXA API for .NET</a></li>
<li><a href="https://docs.sdl.com/DXA/Java/2.2/APIDOC/">DXA API for Java</a></li>
<li><a href="https://docs.rws.com/TridionDocs15.1/PublicContentAPIReference">Content Delivery&#39;s Public Content API</a></li>
</ul>
</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/RWS/tridion-docs-api-docs/blob/main/apiconcepts/Tridion_Docs_15.1/overview.md/#L1" class="contribution-link"></a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h4></h4>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top"></a>
</span>

<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>
2 changes: 1 addition & 1 deletion apiconcepts/Tridion_Docs_15/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h2 id="content-manager-web-services-apihttpsdocsrwscomtridiondocs15webservicesa
<p>Only described API classes and functions are supported and can be used. Do not use any other API function, because they are subject to change.</p>
<h2 id="powershell-modules">PowerShell modules</h2>
<h3 id="ishdeployhttpsdocsrwscomtridiondocs15ishdeploy"><a href="https://docs.rws.com/TridionDocs15/ISHDeploy/">ISHDeploy</a></h3>
<p>ISHDeploy is a PowerShell module that enables the code-as-configuration concept for Tridion Docs, starting from version 13.0.0, up to and including 15.0.0.</p>
<p>ISHDeploy is a PowerShell module that enables the code-as-configuration concept for Tridion Docs, starting from version 13.0.0, up to and including 15.1.0.</p>
<h3 id="ishremotehttpsgithubcomrwsishremote"><a href="https://github.com/RWS/ISHRemote">ISHRemote</a></h3>
<p>ISHRemote is a PowerShell module on top of Tridion Docs Content Manager. Its goal is business automation on top of the Component Content Management System.</p>
<h3 id="ishserverhttpsgithubcomrwsishserver"><a href="https://github.com/RWS/ISHServer">ISHServer</a></h3>
Expand Down
4 changes: 3 additions & 1 deletion apiconcepts/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,10 @@
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h2 id="learn-more-about-tridion-docs-15-apistridiondocs15overviewmd"><a href="Tridion_Docs_15/overview.html">Learn more about Tridion Docs 15 APIs</a></h2>
<h2 id="learn-more-about-tridion-docs-15-apistridiondocs151overviewmd"><a href="Tridion_Docs_15.1/overview.html">Learn more about Tridion Docs 15 APIs</a></h2>

<p>Learn more about the APIs and what you can achieve with them.</p>
<h2 id="learn-more-about-tridion-docs-15-apistridiondocs15overviewmd"><a href="Tridion_Docs_15/overview.html">Learn more about Tridion Docs 15 APIs</a></h2>
<p>Learn more about the APIs and what you can achieve with them.</p>
<h2 id="learn-more-about-tridion-docs-14sp4-apistridiondocs14sp4overviewmd"><a href="Tridion_Docs_14SP4/overview.html">Learn more about Tridion Docs 14SP4 APIs</a></h2>
<p>Learn more about the APIs and what you can achieve with them.</p>
Expand Down
7 changes: 5 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,13 @@ <h1 id="welcome-to-the-tridion-docs-developer-documentation">Welcome to the Trid
<p>Here you’ll find all the information you need to get started developing against your own instance of Tridion Docs. Discover quick guides explaining how to build, develop and deploy your app, plus hints and tips to help you make the most of our APIs.</p>
<p>Should you have any ideas as to how we can improve this documentation, any new topics you think we should include or hints and tips you would like to share with the developer community, please let us know.</p>
<p>To let us know what your suggested improvements are you can do this by using the &quot;<strong>Improve this Doc</strong>&quot; link on the top right of every page. You will need your own github account for this because this action will create a fork of the repository in your account where you can make the changes and then submit a pull request for us to review and accept.</p>
<h2 id="current-release-tridion-docs-15">Current release: Tridion Docs 15</h2>
<p><a href="apiconcepts/Tridion_Docs_15/overview.html">Learn more about the Tridion Docs 15 APIs</a></p>
<h2 id="current-release-tridion-docs-151">Current release: Tridion Docs 15.1</h2>
<p><a href="apiconcepts/Tridion_Docs_15.1/overview.html">Learn more about the Tridion Docs 15.1 APIs</a></p>
<p>Learn more about the APIs and what you can achieve with them.</p>
<h2 id="earlier-releases">Earlier releases</h2>
<h3 id="tridion-docs-15">Tridion Docs 15</h3>
<p><a href="apiconcepts/Tridion_Docs_15/overview.html">Learn more about the Tridion Docs 15 APIs</a></p>
<p>Learn more about the APIs and what you can achieve with them.</p>
<h3 id="tridion-docs-14-sp4">Tridion Docs 14 SP4</h3>
<p><a href="apiconcepts/Tridion_Docs_14SP4/overview.html">Learn more about the Tridion Docs 14SP4 APIs</a></p>
<p>Learn more about the APIs and what you can achieve with them.</p>
Expand Down
Loading

0 comments on commit 0035915

Please sign in to comment.