Skip to content

Commit

Permalink
[develop] Update docs URLs (#3672)
Browse files Browse the repository at this point in the history
* Add Studio API 1 to OAS file #5981

* Update API 1 endpoints missing .json

* Fix typo in write-content API in OAS file

* [develop] Update docs URLs

* Revert mp URL
  • Loading branch information
alhambrav authored Dec 10, 2024
1 parent 91fcc46 commit c206462
Show file tree
Hide file tree
Showing 17 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Crafter Studio
==============

Crafter Studio is the authoring environment for CrafterCMS. For more information, please read the [docs.](http://docs.craftercms.org)
Crafter Studio is the authoring environment for CrafterCMS. For more information, please read the [docs.](http://craftercms.com/docs)

# Community
## Contributors
Expand Down
6 changes: 3 additions & 3 deletions src/main/api/studio-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ servers:
info:
description: |-
Crafter Studio API
version: '4.2.0.0'
version: '5.0.0'
title: Crafter Studio
termsOfService: ''
contact:
email: info@craftercms.org
email: info@craftercms.com
license:
name: GPL 3.0
url: 'https://www.gnu.org/licenses/gpl-3.0.en.html'
externalDocs:
description: CrafterCMS - Studio
url: 'https://docs.craftercms.org/current/reference/modules/studio/index.html'
url: 'https://craftercms.com/docs/current/reference/modules/studio/index.html'
tags:
- name: groups
description: Group management operations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

<form>
<title>Section Defaults</title>
<description>Section Defaults provides inherited values to all children and sibling content items. To learn more about content inheritance see docs.craftercms.org topic &quot;Content Inheritance&quot;</description>
<description>Section Defaults provides inherited values to all children and sibling content items. To learn more about content inheritance see craftercms.com/docs topic &quot;Content Inheritance&quot;</description>
<objectType>component</objectType>
<content-type>/component/level-descriptor</content-type>
<imageThumbnail>section-defaults.png</imageThumbnail>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ plugin:
Editorial blueprint
website:
name: Website Editorial Blueprint
url: https://craftercms.org
url: https://craftercms.com
media:
screenshots:
- title: Home Page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

<form>
<title>Section Defaults</title>
<description>Section Defaults provides inherited values to all children and sibling content items. To learn more about content inheritance see docs.craftercms.org topic &quot;Content Inheritance&quot;</description>
<description>Section Defaults provides inherited values to all children and sibling content items. To learn more about content inheritance see craftercms.com/docs topic &quot;Content Inheritance&quot;</description>
<objectType>component</objectType>
<content-type>/component/level-descriptor</content-type>
<quickCreate>false</quickCreate>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -537,11 +537,11 @@
<![CDATA[<@crafter.DESIRED_TAG $field="FIELD_ID">${contentModel.FIELD_ID}</@crafter.DESIRED_TAG>]]></value>
</specificHTMLTag>
<renderComponentCollection label="Render Component Collection">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=renderComponentCollection&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=renderComponentCollection&check_keywords=yes&area=default -->
<@crafter.renderComponentCollection $field="features_o" $containerAttributes={ "class": "features-container" } $itemAttributes={ "data-custom-attribute": "true" } />]]></value>
</renderComponentCollection>
<renderRepeatGroup label="Render Repeat Group">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=renderRepeatCollection&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=renderRepeatCollection&check_keywords=yes&area=default -->
<@crafter.renderRepeatGroup
$field="VARIABLE_NAME"
$containerAttributes={'attr': 'value'};
Expand All @@ -556,7 +556,7 @@
</@crafter.renderRepeatGroup>]]></value>
</renderRepeatGroup>
<navigation label="Navigation">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=crafter.navigation&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=crafter.navigation&check_keywords=yes&area=default -->
<@crafter.navigation
showNavElement=false
url="NAVIGATION_URL"
Expand All @@ -567,7 +567,7 @@
/>]]></value>
</navigation>
<breadcrumb label="Breadcrumb">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=crafter.breadcrumb&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=crafter.breadcrumb&check_keywords=yes&area=default -->
<@crafter.breadcrumb
url=contentModel.storeUrl
containerElementClass="container-element-class"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ plugin:
GraphQL-based and headless blueprint for a storefront
website:
name: GraphQL Headless Store Blueprint
url: https://craftercms.org
url: https://craftercms.com
media:
screenshots:
- title: Store Items
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

<form>
<title>Section Defaults</title>
<description>Section Defaults provides inherited values to all children and sibling content items. To learn more about content inheritance see docs.craftercms.org topic &quot;Content Inheritance&quot;</description>
<description>Section Defaults provides inherited values to all children and sibling content items. To learn more about content inheritance see craftercms.com/docs topic &quot;Content Inheritance&quot;</description>
<objectType>component</objectType>
<content-type>/component/level-descriptor</content-type>
<imageThumbnail>undefined</imageThumbnail>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
the Crafter Engine's session and are made accessible using the Profile APIs.
You can learn more about personalization and targeting here:
http://docs.craftercms.org/en/3.0/developers/targeting.html
http://craftercms.com/docs/current/by-role/developer/common/targeting.html
<property>
<name />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -529,11 +529,11 @@
<![CDATA[<@crafter.DESIRED_TAG $field="FIELD_ID">${contentModel.FIELD_ID}</@crafter.DESIRED_TAG>]]></value>
</specificHTMLTag>
<renderComponentCollection label="Render Component Collection">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=renderComponentCollection&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=renderComponentCollection&check_keywords=yes&area=default -->
<@crafter.renderComponentCollection $field="features_o" $containerAttributes={ "class": "features-container" } $itemAttributes={ "data-custom-attribute": "true" } />]]></value>
</renderComponentCollection>
<renderRepeatGroup label="Render Repeat Group">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=renderRepeatCollection&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=renderRepeatCollection&check_keywords=yes&area=default -->
<@crafter.renderRepeatGroup
$field="VARIABLE_NAME"
$containerAttributes={'attr': 'value'};
Expand All @@ -548,7 +548,7 @@
</@crafter.renderRepeatGroup>]]></value>
</renderRepeatGroup>
<navigation label="Navigation">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=crafter.navigation&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=crafter.navigation&check_keywords=yes&area=default -->
<@crafter.navigation
showNavElement=false
url="NAVIGATION_URL"
Expand All @@ -559,7 +559,7 @@
/>]]></value>
</navigation>
<breadcrumb label="Breadcrumb">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=crafter.breadcrumb&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=crafter.breadcrumb&check_keywords=yes&area=default -->
<@crafter.breadcrumb
url=contentModel.storeUrl
containerElementClass="container-element-class"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ plugin:
Simple empty blueprint
website:
name: Empty Blueprint
url: https://craftercms.org
url: https://craftercms.com
media:
screenshots:
- title: Home Page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
&lt;li&gt;To create new content types use the Project Tools &amp;gt; Content Types menu on the left Sidebar&lt;/li&gt;
&lt;li&gt;To update markup, edit this template by clicking on the Options menu on the top toolbar and select "Edit Template"&lt;/li&gt;
&lt;li&gt;To modify this text, hover/click on it or use the options menu and select "Edit" on the top toolbar&lt;/li&gt;
&lt;li&gt;Crafter documentation can be found &lt;a href="https://docs.craftercms.org" target="_blank" rel="noopener"&gt;here&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Crafter documentation can be found &lt;a href="https://craftercms.com/docs" target="_blank" rel="noopener"&gt;here&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;CrafterCMS authoring and developer training is available. Please contact &lt;a href="mailto:[email protected]"&gt;[email protected]&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;div&gt;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

<form>
<title>Section Defaults</title>
<description>Section Defaults provides inherited values to all children and sibling content items. To learn more about content inheritance see docs.craftercms.org topic &quot;Content Inheritance&quot;</description>
<description>Section Defaults provides inherited values to all children and sibling content items. To learn more about content inheritance see craftercms.com/docs topic &quot;Content Inheritance&quot;</description>
<objectType>component</objectType>
<content-type>/component/level-descriptor</content-type>
<quickCreate>false</quickCreate>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -527,11 +527,11 @@
<![CDATA[<@crafter.DESIRED_TAG $field="FIELD_ID">${contentModel.FIELD_ID}</@crafter.DESIRED_TAG>]]></value>
</specificHTMLTag>
<renderComponentCollection label="Render Component Collection">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=renderComponentCollection&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=renderComponentCollection&check_keywords=yes&area=default -->
<@crafter.renderComponentCollection $field="features_o" $containerAttributes={ "class": "features-container" } $itemAttributes={ "data-custom-attribute": "true" } />]]></value>
</renderComponentCollection>
<renderRepeatGroup label="Render Repeat Group">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=renderRepeatCollection&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=renderRepeatCollection&check_keywords=yes&area=default -->
<@crafter.renderRepeatGroup
$field="VARIABLE_NAME"
$containerAttributes={'attr': 'value'};
Expand All @@ -546,7 +546,7 @@
</@crafter.renderRepeatGroup>]]></value>
</renderRepeatGroup>
<navigation label="Navigation">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=crafter.navigation&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=crafter.navigation&check_keywords=yes&area=default -->
<@crafter.navigation
showNavElement=false
url="NAVIGATION_URL"
Expand All @@ -557,7 +557,7 @@
/>]]></value>
</navigation>
<breadcrumb label="Breadcrumb">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=crafter.breadcrumb&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=crafter.breadcrumb&check_keywords=yes&area=default -->
<@crafter.breadcrumb
url=contentModel.storeUrl
containerElementClass="container-element-class"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ plugin:
Headless blog blueprint
website:
name: Headless Blog Blueprint
url: https://craftercms.org
url: https://craftercms.com
media:
screenshots:
- title: Author
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@
</headerMappings>
You can learn more about Crafter Engine site configuration in the docs at
http://docs.craftercms.org
http://craftercms.com/docs
-->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,11 +564,11 @@
<value><![CDATA[<@crafter.DESIRED_TAG $field="FIELD_ID">${contentModel.FIELD_ID}</@crafter.DESIRED_TAG>]]></value>
</specificHTMLTag>
<renderComponentCollection label="Render Component Collection">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=renderComponentCollection&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=renderComponentCollection&check_keywords=yes&area=default -->
<@crafter.renderComponentCollection $field="features_o" $containerAttributes={ "class": "features-container" } $itemAttributes={ "data-custom-attribute": "true" } />]]></value>
</renderComponentCollection>
<renderRepeatGroup label="Render Repeat Group">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=renderRepeatCollection&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=renderRepeatCollection&check_keywords=yes&area=default -->
<@crafter.renderRepeatGroup
$field="VARIABLE_NAME"
$containerAttributes={'attr': 'value'};
Expand All @@ -583,7 +583,7 @@
</@crafter.renderRepeatGroup>]]></value>
</renderRepeatGroup>
<navigation label="Navigation">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=crafter.navigation&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=crafter.navigation&check_keywords=yes&area=default -->
<@crafter.navigation
showNavElement=false
url="NAVIGATION_URL"
Expand All @@ -594,7 +594,7 @@
/>]]></value>
</navigation>
<breadcrumb label="Breadcrumb">
<value><![CDATA[<#-- Macro docs @ https://docs.craftercms.org/en/4.0/search.html?q=crafter.breadcrumb&check_keywords=yes&area=default -->
<value><![CDATA[<#-- Macro docs @ https://craftercms.com/docs/4.2/search.html?q=crafter.breadcrumb&check_keywords=yes&area=default -->
<@crafter.breadcrumb
url=contentModel.storeUrl
containerElementClass="container-element-class"
Expand Down

0 comments on commit c206462

Please sign in to comment.