birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated help search and all docs.o3de.org links to o3de.org (#1594)

Browse Source
This commit is contained in:
Terry Michaels
2021-06-25 15:23:57 -05:00
committed by GitHub
parent 4838ad7b9b
commit 21ebff5709
122 changed files with 151 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Code/Framework/AzCore/AzCore/Serialization/EditContextConstants.inl
+1 -1
View File
@@ -181,7 +181,7 @@ namespace AZ
//! @code{.cpp}
//! editContext->Class<ScriptEditorComponent>("Lua Script", "The Lua Script component allows you to add arbitrary Lua logic to an entity in the form of a Lua script")
//! ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
//! ->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://docs.o3de.org/docs/user-guide/components/reference/lua-script/")
//! ->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://o3de.org/docs/user-guide/components/reference/lua-script/")
//! @endcode
const static AZ::Crc32 HelpPageURL = AZ_CRC("HelpPageURL", 0xa344d681);
Code/Framework/AzNetworking/AzNetworking/Framework/ICompressor.h
+2 -2
View File
@@ -31,7 +31,7 @@ namespace AzNetworking
//! @brief Packet data compressor interface.
//!
//! ICompressor is an abstract compression interface meant for user provided GEMs to implement (such as the [Multiplayer
//! Compression Gem](http://docs.o3de.org/docs/user-guide/gems/reference/multiplayer-compression)).
//! Compression Gem](http://o3de.org/docs/user-guide/gems/reference/multiplayer-compression)).
//! Compression is supported for both TCP and UDP connections. Instantiation of a compressor is controlled by the
//! `net_UdpCompressor` or `net_TcpCompressor` cvar for their respective protocols.
@@ -94,7 +94,7 @@ namespace AzNetworking
//! ICompressorFactory is an abstract compression interface meant for user provided GEMs to implement. ICompressorFactory
//! implementations can be registered to classes implementing INetworking. Registered factories can then be used to create
//! ICompressor implementations on demand. The [Multiplayer Compression
//! Gem](http://docs.o3de.org/docs/user-guide/gems/reference/multiplayer-compression) is an example of an ICompressorFactory
//! Gem](http://o3de.org/docs/user-guide/gems/reference/multiplayer-compression) is an example of an ICompressorFactory
//! for an LZ4 Compressor. In it, MultiplayerCompressionSystemComponent registers its ICompressorFactory with
//! NetworkingSystemComponent, which is an implementation of INetworking. Registered factories are keyed by their AZ Name
//! which is accessed through the factory's GetFactoryName method.
Code/Framework/AzNetworking/AzNetworking/Framework/INetworking.h
+1 -1
View File
@@ -25,7 +25,7 @@ namespace AzNetworking
//!
//! INetworking is also responsible for registering ICompressorFactory implementations. This allows a developer to have
//! access to multiple ICompressorFactory implementations by name. The [MultiplayerCompressor
//! Gem](http://docs.o3de.org/docs/user-guide/gems/reference/multiplayer-compression) is an example of this using the
//! Gem](http://o3de.org/docs/user-guide/gems/reference/multiplayer-compression) is an example of this using the
//! [LZ4](https://wikipedia.org/wiki/LZ4_%28compression_algorithm%29) algorithm.
//!
Code/Framework/AzNetworking/AzNetworking/PacketLayer/IPacket.h
+1 -1
View File
@@ -27,7 +27,7 @@ namespace AzNetworking
//! ISerializer to move data between hosts safely and efficiently.
//!
//! For more information on the packet format and best practices for extending the packet system, read
//! [Networking Packets](http://docs.o3de.org/docs/user-guide/networking/packets) on the O3DE documentation site.
//! [Networking Packets](http://o3de.org/docs/user-guide/networking/packets) on the O3DE documentation site.
class IPacket
{
public:
Code/Framework/AzNetworking/AzNetworking/TcpTransport/TcpNetworkInterface.h
+1 -1
View File
@@ -34,7 +34,7 @@ namespace AzNetworking
//! * Header - Details the type of packet and other information related to reliability
//! * Payload - The actual serialized content of the packet
//!
//! For more information, read [Networking Packets](http://docs.o3de.org/docs/user-guide/networking/packets) in the O3DE documentation.
//! For more information, read [Networking Packets](http://o3de.org/docs/user-guide/networking/packets) in the O3DE documentation.
//!
//! ## Reliability
//!
Code/Framework/AzNetworking/AzNetworking/UdpTransport/UdpNetworkInterface.h
+2 -2
View File
@@ -43,7 +43,7 @@ namespace AzNetworking
//! * Header - Details the type of packet and other information related to reliability
//! * Payload - The actual serialized content of the packet
//!
//! For more information, read [Networking Packets](http://docs.o3de.org/docs/user-guide/networking/packets) in the O3DE documentation.
//! For more information, read [Networking Packets](http://o3de.org/docs/user-guide/networking/packets) in the O3DE documentation.
//!
//! ### Reliability
//!
@@ -72,7 +72,7 @@ namespace AzNetworking
//! ### Encryption
//!
//! AzNetworking uses the [OpenSSL](https://www.openssl.org/) library to implement Datagram Layer Transport Security (DTLS) encryption
//! on UDP traffic. Encryption operates as described in [O3DE Networking Encryption](http://docs.o3de.org/docs/user-guide/networking/encryption)
//! on UDP traffic. Encryption operates as described in [O3DE Networking Encryption](http://o3de.org/docs/user-guide/networking/encryption)
//! on the documentation website. Once both endpoints have completed their handshake, all traffic is expected to be fully encrypted.
class UdpNetworkInterface final
: public INetworkInterface
Code/Framework/AzQtComponents/AzQtComponents/AzQtComponentsAPI.h
+1 -1
View File
@@ -19,7 +19,7 @@
* API refernce for all tools developers that are extending Open 3D Engine. The API reference
* is intended for C++ programmers building tools. For UX designers looking to understand
* the best patterns and practices when making a tool to comfortably integrate with
* the Open 3D Engine editor, see the [UI 2.0 design guide](https://docs.o3de.org/docs/tools-ui/ui-dev-intro/).
* the Open 3D Engine editor, see the [UI 2.0 design guide](https://o3de.org/docs/tools-ui/ui-dev-intro/).
*/
#include <AzCore/PlatformDef.h>
Code/Framework/AzQtComponents/AzQtComponents/Gallery/CardPage.cpp
+4 -4
View File
@@ -64,7 +64,7 @@ AzQtComponents::CardHeader* header = ui->functionalCard->header();
header->setIcon(QIcon(":/Cards/img/UI20/Cards/slice_item.png"));
// Set the help url to open in a browser if the user clicks the help button
header->setHelpURL("https://docs.o3de.org/docs/");
header->setHelpURL("https://o3de.org/docs/");
// Clear the help url
header->clearHelpURL();
@@ -103,7 +103,7 @@ card->mockDisabledState(true);
ui->disabledCard->setTitle("Actually Disabled Card");
ui->disabledCard->setContentWidget(new QWidget());
ui->disabledCard->header()->setIcon(QIcon(QStringLiteral(":/stylesheet/img/search.svg")));
ui->disabledCard->header()->setHelpURL("https://docs.o3de.org/docs/");
ui->disabledCard->header()->setHelpURL("https://o3de.org/docs/");
ui->disabledCard->setSecondaryTitle("Secondary Title");
ui->disabledCard->setSecondaryContentWidget(new QWidget());
ui->disabledCard->setEnabled(false);
@@ -111,7 +111,7 @@ card->mockDisabledState(true);
ui->disabledCard2->setTitle("Mock Disabled Card");
ui->disabledCard2->setContentWidget(new QWidget());
ui->disabledCard2->header()->setIcon(QIcon(QStringLiteral(":/stylesheet/img/search.svg")));
ui->disabledCard2->header()->setHelpURL("https://docs.o3de.org/docs/");
ui->disabledCard2->header()->setHelpURL("https://o3de.org/docs/");
ui->disabledCard2->setSecondaryTitle("Secondary Title");
ui->disabledCard2->setSecondaryContentWidget(new QWidget());
ui->disabledCard2->mockDisabledState(true);
@@ -122,7 +122,7 @@ card->mockDisabledState(true);
// put in an example icon
AzQtComponents::CardHeader* header = ui->functionalCard->header();
header->setIcon(QIcon(":/Cards/img/UI20/Cards/slice_item.png"));
header->setHelpURL("https://docs.o3de.org/docs/");
header->setHelpURL("https://o3de.org/docs/");
connect(ui->addButton, &QPushButton::clicked, this, &CardPage::addNotification);
Code/Framework/AzQtComponents/AzQtComponents/Gallery/ReflectedPropertyEditorPage.cpp
+1 -1
View File
@@ -316,7 +316,7 @@ See the documentation linked above for more details.
)";
ui->exampleText->setHtml(exampleText);
ui->hyperlinkLabel->setText(QStringLiteral(R"(<a href="https://docs.o3de.org/docs/user-guide/components/development/reflection/">Reflected Property Editor docs</a>)"));
ui->hyperlinkLabel->setText(QStringLiteral(R"(<a href="https://o3de.org/docs/user-guide/components/development/reflection/">Reflected Property Editor docs</a>)"));
}
ReflectedPropertyEditorPage::~ReflectedPropertyEditorPage()
Code/Framework/AzToolsFramework/AzToolsFramework/PythonTerminal/ScriptTermDialog.cpp
+1 -1
View File
@@ -51,7 +51,7 @@ namespace AzToolsFramework
connect(ui->SCRIPT_INPUT, &QLineEdit::textChanged, this, &CScriptTermDialog::OnScriptInputTextChanged);
connect(ui->SCRIPT_HELP, &QToolButton::clicked, this, &CScriptTermDialog::OnScriptHelp);
connect(ui->SCRIPT_DOCS, &QToolButton::clicked, this, []() {
QDesktopServices::openUrl(QUrl("https://docs.o3de.org/docs/user-guide/scripting/"));
QDesktopServices::openUrl(QUrl("https://o3de.org/docs/user-guide/scripting/"));
});
InitCompleter();
Code/Framework/AzToolsFramework/AzToolsFramework/ToolsComponents/ScriptEditorComponent.cpp
+1 -1
View File
@@ -1023,7 +1023,7 @@ namespace AzToolsFramework
->Attribute(AZ::Edit::Attributes::Icon, "Icons/Components/LuaScript.svg")
->Attribute(AZ::Edit::Attributes::PrimaryAssetType, AZ::AzTypeInfo<AZ::ScriptAsset>::Uuid())
->Attribute(AZ::Edit::Attributes::ViewportIcon, "Icons/Components/Viewport/Script.png")
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://docs.o3de.org/docs/user-guide/components/reference/lua-script/")
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://o3de.org/docs/user-guide/components/reference/lua-script/")
->DataElement("AssetRef", &ScriptEditorComponent::m_scriptAsset, "Script", "Which script to use")
->Attribute(AZ::Edit::Attributes::ChangeNotify, &ScriptEditorComponent::ScriptHasChanged)
->Attribute("BrowseIcon", ":/stylesheet/img/UI20/browse-edit-select-files.svg")
Code/Framework/AzToolsFramework/Tests/Entity/EditorEntitySearchComponentTests.cpp
+2 -2
View File
@@ -47,7 +47,7 @@ namespace AzToolsFramework
->Attribute(AZ::Edit::Attributes::Icon, "Icons/Components/Tag.png")
->Attribute(AZ::Edit::Attributes::ViewportIcon, "Icons/Components/Viewport/Tag.png")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://docs.o3de.org/docs/user-guide/components")
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://o3de.org/docs/user-guide/components")
->DataElement(AZ::Edit::UIHandlers::Default, &EntitySearch_TestComponent1::m_boolValue, "Bool", "")
->DataElement(AZ::Edit::UIHandlers::Default, &EntitySearch_TestComponent1::m_intValue, "Int", "")
;
@@ -106,7 +106,7 @@ namespace AzToolsFramework
->Attribute(AZ::Edit::Attributes::Icon, "Icons/Components/Tag.png")
->Attribute(AZ::Edit::Attributes::ViewportIcon, "Icons/Components/Viewport/Tag.png")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://docs.o3de.org/docs/user-guide/components")
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://o3de.org/docs/user-guide/components")
->DataElement(AZ::Edit::UIHandlers::Default, &EntitySearch_TestComponent2::m_floatValue, "Float", "")
;
}
Code/Framework/AzToolsFramework/Tests/EntityInspectorTests.cpp
+2 -2
View File
@@ -118,7 +118,7 @@ namespace UnitTest
->Attribute(AZ::Edit::Attributes::Icon, "Icons/Components/Tag.png")
->Attribute(AZ::Edit::Attributes::ViewportIcon, "Icons/Components/Viewport/Tag.png")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://docs.o3de.org/docs/user-guide/components")
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://o3de.org/docs/user-guide/components")
->DataElement(AZ::Edit::UIHandlers::Default, &Inspector_TestComponent2::m_data, "Data", "The component's Data");
}
}
@@ -187,7 +187,7 @@ namespace UnitTest
->Attribute(AZ::Edit::Attributes::Icon, "Icons/Components/Tag.png")
->Attribute(AZ::Edit::Attributes::ViewportIcon, "Icons/Components/Viewport/Tag.png")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://docs.o3de.org/docs/user-guide/components")
->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://o3de.org/docs/user-guide/components")
->DataElement(AZ::Edit::UIHandlers::Default, &Inspector_TestComponent3::m_data, "Data", "The component's Data");
}
}
Code/Sandbox/Editor/AssetImporter/UI/SelectDestinationDialog.cpp
+1 -1
View File
@@ -19,7 +19,7 @@ AZ_PUSH_DISABLE_DLL_EXPORT_MEMBER_WARNING
AZ_POP_DISABLE_DLL_EXPORT_MEMBER_WARNING
static const char* g_assetProcessorLink = "<a href=\"https://docs.o3de.org/docs/user-guide/assets/pipeline/processor-ui/\">Asset Processor</a>";
static const char* g_assetProcessorLink = "<a href=\"https://o3de.org/docs/user-guide/assets/pipeline/processor-ui/\">Asset Processor</a>";
static const char* g_copyFilesMessage = "The original file will remain outside of the project and the %1 will not monitor the file.";
static const char* g_moveFilesMessage = "The original file will be moved inside of the project and the %1 will monitor the file for changes.";
static const char* g_selectDestinationFilesPath = "AssetImporter/SelectDestinationFilesPath";
Code/Sandbox/Editor/Core/LevelEditorMenuHandler.cpp
+3 -10
View File
@@ -798,7 +798,7 @@ QMenu* LevelEditorMenuHandler::CreateHelpMenu()
auto text = lineEdit->text();
if (text.isEmpty())
{
QDesktopServices::openUrl(QUrl("https://docs.o3de.org/docs/"));
QDesktopServices::openUrl(QUrl("https://o3de.org/docs/"));
}
else
{
@@ -807,17 +807,10 @@ QMenu* LevelEditorMenuHandler::CreateHelpMenu()
const SFileVersion& productVersion = gEnv->pSystem->GetProductVersion();
productVersion.ToString(productVersionString, versionStringSize);
QUrl docSearchUrl("https://docs.aws.amazon.com/search/doc-search.html");
QUrl docSearchUrl("https://o3de.org/docs/");
QUrlQuery docSearchQuery;
QString o3deProductString = QUrl::toPercentEncoding("Open 3D Engine");
// The order of these QueryItems matters. wiki Search URL Formatting
docSearchQuery.addQueryItem("searchPath", "documentation-product");
docSearchQuery.addQueryItem("searchQuery", text);
docSearchQuery.addQueryItem("this_doc_product", o3deProductString);
docSearchQuery.addQueryItem("ref", "lye");
docSearchQuery.addQueryItem("ev", productVersionString);
docSearchQuery.addQueryItem("query", text);
docSearchUrl.setQuery(docSearchQuery);
docSearchUrl.setFragment(QString("facet_doc_product=%1").arg(o3deProductString));
QDesktopServices::openUrl(docSearchUrl);
}
lineEdit->clear();
Code/Tools/AssetBundler/source/ui/MainWindow.cpp
+1 -1
View File
@@ -199,7 +199,7 @@ namespace AssetBundler
void MainWindow::OnSupportClicked()
{
QDesktopServices::openUrl(
QStringLiteral("https://docs.o3de.org/docs/user-guide/packaging/asset-bundler/"));
QStringLiteral("https://o3de.org/docs/user-guide/packaging/asset-bundler/"));
}
void MainWindow::ShowLogContextMenu(const QPoint& pos)
Code/Tools/AssetProcessor/native/ui/MainWindow.cpp
+1 -1
View File
@@ -509,7 +509,7 @@ void MainWindow::OnRescanButtonClicked()
void MainWindow::OnSupportClicked(bool /*checked*/)
{
QDesktopServices::openUrl(
QStringLiteral("https://docs.o3de.org/docs/user-guide/assets/pipeline/"));
QStringLiteral("https://o3de.org/docs/user-guide/assets/pipeline/"));
}
void MainWindow::EditConnection(const QModelIndex& index)
Code/Tools/AssetProcessor/native/ui/ProductAssetDetailsPanel.cpp
+1 -1
View File
@@ -438,7 +438,7 @@ namespace AssetProcessor
void ProductAssetDetailsPanel::OnSupportClicked(bool /*checked*/)
{
QDesktopServices::openUrl(
QStringLiteral("https://docs.o3de.org/docs/user-guide/packaging/asset-bundler/assets-resolving/"));
QStringLiteral("https://o3de.org/docs/user-guide/packaging/asset-bundler/assets-resolving/"));
}