diff --git a/404.html b/404.html index f54ba62..6516a61 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ - + @@ -29,11 +29,11 @@ - + - + - + diff --git a/about/index.html b/about/index.html index ed6f0cd..5c13062 100644 --- a/about/index.html +++ b/about/index.html @@ -4,7 +4,7 @@ - + @@ -32,11 +32,11 @@ - + - + - + diff --git a/backend/domain-event-propagation/index.html b/backend/domain-event-propagation/index.html index f4af9bd..a45e598 100644 --- a/backend/domain-event-propagation/index.html +++ b/backend/domain-event-propagation/index.html @@ -4,7 +4,7 @@ - + @@ -30,11 +30,11 @@ - + - + - + diff --git a/backend/mediatr-extensions/index.html b/backend/mediatr-extensions/index.html index a2475e8..fdb0624 100644 --- a/backend/mediatr-extensions/index.html +++ b/backend/mediatr-extensions/index.html @@ -4,7 +4,7 @@ - + @@ -30,11 +30,11 @@ - + - + - + diff --git a/backend/mongo-extensions/index.html b/backend/mongo-extensions/index.html index 36a7234..0af5526 100644 --- a/backend/mongo-extensions/index.html +++ b/backend/mongo-extensions/index.html @@ -4,7 +4,7 @@ - + @@ -30,11 +30,11 @@ - + - + - + diff --git a/frontend/foundry-cli/index.html b/frontend/foundry-cli/index.html index a79ae1b..a0fadf6 100644 --- a/frontend/foundry-cli/index.html +++ b/frontend/foundry-cli/index.html @@ -4,7 +4,7 @@ - + @@ -30,11 +30,11 @@ - + - + - + diff --git a/frontend/hopper/index.html b/frontend/hopper/index.html index b6e55f5..56ff4d1 100644 --- a/frontend/hopper/index.html +++ b/frontend/hopper/index.html @@ -4,7 +4,7 @@ - + @@ -30,11 +30,11 @@ - + - + - + diff --git a/frontend/squide/index.html b/frontend/squide/index.html index 019c3b7..0d5e04d 100644 --- a/frontend/squide/index.html +++ b/frontend/squide/index.html @@ -4,7 +4,7 @@ - + @@ -30,11 +30,11 @@ - + - + - + diff --git a/frontend/web-configs/index.html b/frontend/web-configs/index.html index d696e9f..bcead60 100644 --- a/frontend/web-configs/index.html +++ b/frontend/web-configs/index.html @@ -4,7 +4,7 @@ - + @@ -30,11 +30,11 @@ - + - + - + diff --git a/index.html b/index.html index 33475dd..a959d28 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ - + @@ -34,11 +34,11 @@ - + - + - + diff --git a/joining-the-hub/index.html b/joining-the-hub/index.html index b3fd2be..482d08e 100644 --- a/joining-the-hub/index.html +++ b/joining-the-hub/index.html @@ -4,7 +4,7 @@ - + @@ -32,12 +32,12 @@ - + - + - - + + diff --git a/resources/js/config.js b/resources/js/config.js index a907d92..d34b501 100644 --- a/resources/js/config.js +++ b/resources/js/config.js @@ -1 +1 @@ -var __DOCS_CONFIG__ = {"id":"Vj1RHELtq160VuYqapj4vcubXKbQaAJoo8","key":"eswN3GZ7ojpVQW78EVIBRd5waPhIul34Ji7vSwSi+YY.nw52hIUmjhIGHLtZuhh8GNrz+0R9k2ONhI9swUFpfoGNXWNshKefUaz6oWxM/3B8r60M9zR7O2KZQS4twhv63w.300048","base":"/wl-idp-docs-hub/","host":"gsoft-inc.github.io","version":"1.0.0","useRelativePaths":true,"documentName":"index.html","appendDocumentName":false,"trailingSlash":true,"preloadSearch":false,"cacheBustingToken":"3.5.0.748981580438","cacheBustingStrategy":"query","sidebarFilterPlaceholder":"Filter","toolbarFilterPlaceholder":"Filter","showSidebarFilter":true,"filterNotFoundMsg":"No member names found containing the query \"{query}\"","maxHistoryItems":15,"homeIcon":"","access":[{"value":"public","label":"Public"},{"value":"protected","label":"Protected"}],"toolbarLinks":[{"id":"fields","label":"Fields"},{"id":"properties","label":"Properties"},{"id":"methods","label":"Methods"},{"id":"events","label":"Events"}],"sidebar":[{"n":"/","l":"Workleap Internal Developer Platform (IDP)","v":false},{"n":"frontend","l":"Frontend","c":false,"o":true,"i":[{"n":"foundry-cli","u":"https://github.com/gsoft-inc/wl-foundry-cli","l":"Foundry CLI"},{"n":"web-configs","u":"https://gsoft-inc.github.io/wl-web-configs","l":"Web configs"},{"n":"squide","u":"https://gsoft-inc.github.io/wl-squide","l":"Squide"},{"n":"hopper","u":"https://hopper.workleap.design","l":"Hopper"}],"s":""},{"n":"backend","l":"Backend","c":false,"o":true,"i":[{"n":"domain-event-propagation","u":"https://github.com/gsoft-inc/wl-domain-event-propagation","l":"Domain event propagation"},{"n":"mediatr-extensions","u":"https://github.com/gsoft-inc/wl-extensions-mediatr","l":"Mediatr extensions"},{"n":"mongo-extensions","u":"https://github.com/gsoft-inc/wl-extensions-mongo","l":"Mongo extensions"}],"s":""},{"n":"joining-the-hub","l":"Joining the hub","s":""},{"n":"why-retype","l":"Why Retype","s":""},{"n":"about","l":"About","v":false}],"search":{"mode":0,"minChars":2,"maxResults":20,"placeholder":"Search","hotkeys":["k"],"noResultsFoundMsg":"Sorry, no results found.","recognizeLanguages":true,"languages":[0],"preload":false},"resources":{"History_Title_Label":"History","History_ClearLink_Label":"Clear","History_NoHistory_Label":"No history items","API_AccessFilter_Label":"Access","API_ParameterSection_Label":"PARAMETERS","API_SignatureSection_Label":"SIGNATURE","API_CopyHint_Label":"Copy","API_CopyNameHint_Label":"Copy name","API_CopyLinkHint_Label":"Copy link","API_CopiedAckHint_Label":"Copied!","API_MoreOverloads_Label":"more","API_MoreDropdownItems_Label":"More","API_OptionalParameter_Label":"optional","API_DefaultParameterValue_Label":"Default value","API_InheritedFilter_Label":"Inherited","Search_Input_Placeholder":"Search","Toc_Contents_Label":"Contents","Toc_RelatedClasses_Label":"Related Classes","History_JustNowTime_Label":"just now","History_AgoTime_Label":"ago","History_YearTime_Label":"y","History_MonthTime_Label":"mo","History_DayTime_Label":"d","History_HourTime_Label":"h","History_MinuteTime_Label":"m","History_SecondTime_Label":"s"}}; +var __DOCS_CONFIG__ = {"id":"AbDTnqm3h16Pkw6JQ0bM1Ph+/bdGfrZ6/b","key":"vQlaelavVcXeal9+v/gw5GUZ1WjHhWJTqsmshToxKlc.I//cYaKXLRRCMrMOK8BF5BeHR2iQIrlWwZgb+oD2LlX1yHkHmdUK8CrSQp/hHjdRtZP9jrwcvWmA4j28y3rPnQ.300118","base":"/wl-idp-docs-hub/","host":"gsoft-inc.github.io","version":"1.0.0","useRelativePaths":true,"documentName":"index.html","appendDocumentName":false,"trailingSlash":true,"preloadSearch":false,"cacheBustingToken":"3.5.0.748981784377","cacheBustingStrategy":"query","sidebarFilterPlaceholder":"Filter","toolbarFilterPlaceholder":"Filter","showSidebarFilter":true,"filterNotFoundMsg":"No member names found containing the query \"{query}\"","maxHistoryItems":15,"homeIcon":"","access":[{"value":"public","label":"Public"},{"value":"protected","label":"Protected"}],"toolbarLinks":[{"id":"fields","label":"Fields"},{"id":"properties","label":"Properties"},{"id":"methods","label":"Methods"},{"id":"events","label":"Events"}],"sidebar":[{"n":"/","l":"Workleap Internal Developer Platform (IDP)","v":false},{"n":"frontend","l":"Frontend","c":false,"o":true,"i":[{"n":"foundry-cli","u":"https://github.com/gsoft-inc/wl-foundry-cli","l":"Foundry CLI"},{"n":"web-configs","u":"https://gsoft-inc.github.io/wl-web-configs","l":"Web configs"},{"n":"squide","u":"https://gsoft-inc.github.io/wl-squide","l":"Squide"},{"n":"hopper","u":"https://hopper.workleap.design","l":"Hopper"}],"s":""},{"n":"backend","l":"Backend","c":false,"o":true,"i":[{"n":"domain-event-propagation","u":"https://github.com/gsoft-inc/wl-domain-event-propagation","l":"Domain event propagation"},{"n":"mediatr-extensions","u":"https://github.com/gsoft-inc/wl-extensions-mediatr","l":"Mediatr extensions"},{"n":"mongo-extensions","u":"https://github.com/gsoft-inc/wl-extensions-mongo","l":"Mongo extensions"}],"s":""},{"n":"joining-the-hub","l":"Joining the hub","s":""},{"n":"why-retype","l":"Why Retype","s":""},{"n":"about","l":"About","v":false}],"search":{"mode":0,"minChars":2,"maxResults":20,"placeholder":"Search","hotkeys":["k"],"noResultsFoundMsg":"Sorry, no results found.","recognizeLanguages":true,"languages":[0],"preload":false},"resources":{"History_Title_Label":"History","History_ClearLink_Label":"Clear","History_NoHistory_Label":"No history items","API_AccessFilter_Label":"Access","API_ParameterSection_Label":"PARAMETERS","API_SignatureSection_Label":"SIGNATURE","API_CopyHint_Label":"Copy","API_CopyNameHint_Label":"Copy name","API_CopyLinkHint_Label":"Copy link","API_CopiedAckHint_Label":"Copied!","API_MoreOverloads_Label":"more","API_MoreDropdownItems_Label":"More","API_OptionalParameter_Label":"optional","API_DefaultParameterValue_Label":"Default value","API_InheritedFilter_Label":"Inherited","Search_Input_Placeholder":"Search","Toc_Contents_Label":"Contents","Toc_RelatedClasses_Label":"Related Classes","History_JustNowTime_Label":"just now","History_AgoTime_Label":"ago","History_YearTime_Label":"y","History_MonthTime_Label":"mo","History_DayTime_Label":"d","History_HourTime_Label":"h","History_MinuteTime_Label":"m","History_SecondTime_Label":"s"}}; diff --git a/resources/js/search.json b/resources/js/search.json index 93c155f..c2ac98f 100644 --- a/resources/js/search.json +++ b/resources/js/search.json @@ -1 +1 @@ -[[{"i":"workleap-internal-developer-platform-idp","l":"Workleap Internal Developer Platform (IDP)","p":["Welcome to the documentation hub for Workleap IDP libraries. On this site, you'll discover a variety of libraries that collectively constitutes the internal developer platform for creating applications on the Workleap platform."]}],[],[],[],[],[],[],[],[{"l":"Joining the hub","p":["To include your library documentation in Workleap's IDP hub, follow these steps."]},{"l":"Create your Retype website","p":["First, navigate to the Retype getting started guide to set up a Retype website within your library repository."]},{"l":"Basic setup","p":["Then, open the retype.yml file located at the root of the repository and copy/paste the following basic configuration:","Finally, add the following script to your package.json file:","Please note that Retype is also compatible with .NET projects. If you are working on a .NET project, visit the Retype website for guidance on starting your Retype development."]},{"i":"try-it","l":"Try it \uD83D\uDE80","p":["Start your Retype site by executing the dev-docs script."]},{"i":"adhere-to-workleaps-conventions","l":"Adhere to Workleap's conventions","p":["The following conventions are optional but highly recommend to to guarantee a consistent and unified experience for Workleap's developers within the Workleap IDP hub."]},{"l":"Icons","p":["First, add Workleap's reversed bleu logo and favicon to the /docs/static folder:","Then, configure Retype to use the new assets by including the following configurations to your retype.yml file:"]},{"l":"Top bar links","p":["A link to a page listing your library releases.","A link to request a new feature for your library.","A link to the homepage of your Retype site.","A link to the library's packages.","A link to your library's bug tracker.","A link to your library's repository.","Description","Feature requests","Found a bug","GitHub (or another platform)","Home","Link","NPM / Nugget","Releases","Then, add the following links to the top nav bar of your Retype site:","Your Retype links configuration should closely resemble the following configurations"]},{"l":"Footer links","p":["Then, add the following links to the footer of your Retype site:","Link","Description","About","A link to an about page including meta informations about your library project ( example).","License","A link to the license of your library.","Your Retype footer links configuration should closely resemble the following configurations"]},{"l":"Retype navigation folder items","p":["We recommend adding an icon before each folder item of the main navigation (on the left):","Icon","Section","Use a rocket icon for a \"Getting Started\" section ( example).","Use a book icon for a \"Guides\" section ( example).","Use a gear icon for a \"Reference\" section ( example).","Use a question icon for a \"Troubleshooting\" section ( example).","Use a command-palette icon for a \"Sample\" section ( example)."]},{"l":"Include the shared CSS customizations file","p":["Our Retype websites share a CSS file that contains several customizations to enhance the default Retype style. To incorporate this file into your Retype site, follow these steps:"]},{"i":"create-the-_includesheadhtml-file","l":"Create the _includes/head.html file","p":["Create a _includes/head.html file within the /docs folder:"]},{"l":"Link the shared CSS file","p":["Then, open the newly created _includes/head.html file and copy/paste the following content:"]},{"l":"Activate pro features","p":["Workleap has acquired an Enterprise license for Retype, which you can locate the key in our secure Vault. To enable Retype's pro features, copy and paste the following configuration into your retype.yml file:"]},{"l":"Configure your Retype wallet","p":["Since we've added the following lines to your retype.yml file:","You can now develop a Retype site locally with the pro features without the need for a local Retype wallet. However, if you prefer to set up your local Retype wallet, follow these steps:","Locate the Retype license key in our secure Vault.","Utilize the Retype CLI to create your wallet."]},{"l":"Host the site on GitHub pages","p":["To use our Retype enterprise license, and for every hub features of Retype to work properly, the site must be hosted on the https://gsoft-inc.github.io domain. As this is a GitHub Pages domain, to join the hub, your Retype site must be deployed with GitHub Pages.","To configure your Retype site to be deployed with GitHub Pages, refer to the following guide.","You don't need to set the Retype Enterprise license key as it's already configured as an organization secret."]},{"l":"Add the site to the hub","p":["Send a PR to the wl-idp-docs-hub GitHub repository to add your site to the hub. Once merged, your site will be automatically added to the Workleap IDP hub!"]}],[{"l":"Why Retype over GitHub readme","p":["While GitHub README.md files are great, there are a few advantages to use a documentation platform like Retype:","Better Structuring: Retype simplifies the organization of documentation by allowing easy division into multiple files and provides an intuitive navigation system with a left sidebar for seamless browsing.","Automatic Table of Contents: Retype generates an in-page Table of Contents automatically from the page's headers, improving navigation within the documentation.","Powerful Search: Retype integrates advanced content search functionality, enabling developers to quickly locate the information they need.","Broken Link Detection: Retype's compilers swiftly identify any broken links (including anchors), ensuring that your documentation remains error-free.","Advanced Code Block Features: Retype's code blocks support features like line highlighting and optional titles, enhancing the presentation of code samples.","Outbound Links: Retype automatically identifies and manages external (outbound) links within the project, opening them in new tabs when clicked for a smoother user experience.","Multiple Layouts: Retype offers three distinct layouts out of the box: page, central, and blog, allowing flexibility in presentation.","Pages Visibility Control: Retype supports both Private& Protected pages, enabling controlled access to content.","Custom CSS: Retype allows to add custom global CSS and CSS classes to containers.","The Hub functionality: Retype's hub functionality enables the interlinking of multiple websites, facilitating seamless navigation between related resources.","By choosing Retype, we can take advantage of these features to enhance our documentation's organization, accessibility, and overall developers experience."]}],[{"l":"About","p":["To ask a question or propose an idea, feel free to start a new discussion on Github. If you found a bug, please open an issue on Github."]},{"l":"License","p":["See the LICENSE on Github."]}]] \ No newline at end of file +[[{"i":"workleap-internal-developer-platform-idp","l":"Workleap Internal Developer Platform (IDP)","p":["Welcome to the documentation hub for Workleap IDP libraries. On this site, you'll discover a variety of libraries that collectively constitutes the internal developer platform for creating applications on the Workleap platform."]}],[],[],[],[],[],[],[],[{"l":"Joining the hub","p":["To include your library documentation in Workleap's IDP hub, follow these steps."]},{"l":"Create your Retype website","p":["First, navigate to the Retype getting started guide to set up a Retype website within your library repository."]},{"l":"Basic setup","p":["Then, open the retype.yml file located at the root of the repository and copy/paste the following basic configuration:","Finally, add the following script to your package.json file:","Please note that Retype is also compatible with .NET projects. If you are working on a .NET project, visit the Retype website for guidance on starting your Retype development."]},{"i":"try-it","l":"Try it \uD83D\uDE80","p":["Start your Retype site by executing the dev-docs script."]},{"i":"adhere-to-workleaps-conventions","l":"Adhere to Workleap's conventions","p":["The following conventions are optional but highly recommend to to guarantee a consistent and unified experience for Workleap's developers within the Workleap IDP hub."]},{"l":"Icons","p":["First, add Workleap's reversed bleu logo and favicon to the /docs/static folder:","Then, configure Retype to use the new assets by including the following configurations to your retype.yml file:"]},{"l":"Top bar links","p":["A link to a page listing your library releases.","A link to request a new feature for your library.","A link to the homepage of your Retype site.","A link to the library's packages.","A link to your library's bug tracker.","A link to your library's repository.","Description","Feature requests","Found a bug","GitHub (or another platform)","Home","Link","NPM / Nugget","Releases","Then, add the following links to the top nav bar of your Retype site:","Your Retype links configuration should closely resemble the following configurations"]},{"l":"Footer links","p":["Then, add the following links to the footer of your Retype site:","Link","Description","About","A link to an about page including meta informations about your library project ( example).","License","A link to the license of your library.","Your Retype footer links configuration should closely resemble the following configurations"]},{"l":"Retype navigation folder items","p":["We recommend adding an icon before each folder item of the main navigation (on the left):","Icon","Section","Use a rocket icon for a \"Getting Started\" section ( example).","Use a book icon for a \"Guides\" section ( example).","Use a gear icon for a \"Reference\" section ( example).","Use a question icon for a \"Troubleshooting\" section ( example).","Use a command-palette icon for a \"Sample\" section ( example)."]},{"l":"Include the shared CSS customizations file","p":["Our Retype websites share a CSS file that contains several customizations to enhance the default Retype style. To incorporate this file into your Retype site, follow these steps:"]},{"i":"create-the-_includesheadhtml-file","l":"Create the _includes/head.html file","p":["Create a _includes/head.html file within the /docs folder:"]},{"l":"Link the shared CSS file","p":["Then, open the newly created _includes/head.html file and copy/paste the following content:"]},{"l":"Activate pro features","p":["Workleap has acquired an Enterprise license for Retype, which you can locate the key in our secure Vault. To enable Retype's pro features, copy and paste the following configuration into your retype.yml file:"]},{"l":"Configure your Retype wallet","p":["Since we've added the following lines to your retype.yml file:","You can now develop a Retype site locally with the pro features without the need for a local Retype wallet. However, if you prefer to set up your local Retype wallet, follow these steps:","Locate the Retype license key in our secure Vault.","Utilize the Retype CLI to create your wallet."]},{"l":"Host the site on GitHub pages","p":["To use our Retype enterprise license, and for every hub features of Retype to work properly, the site must be hosted on the https://gsoft-inc.github.io domain. As this is a GitHub Pages domain, to join the hub, your Retype site must be deployed with GitHub Pages.","To configure your Retype site to be deployed with GitHub Pages, refer to the following guide.","You don't need to set the Retype Enterprise license key as it's already configured as an organization secret."]},{"l":"Add the site to the hub","p":["Send a PR to the wl-idp-docs-hub GitHub repository to add your site to the hub. Once merged, your site will be automatically added to the Workleap IDP hub!"]}],[{"l":"Why Retype over GitHub readme","p":["While GitHub README.md files are great, there are several compelling reasons to consider using a documentation platform like Retype:","Better Structuring: Retype simplifies the organization of documentation by allowing easy division into multiple files and provides an intuitive navigation system with a left sidebar for seamless browsing.","Automatic Table of Contents: Retype generates an in-page Table of Contents automatically from the page's headers, improving navigation within the documentation.","Powerful Search: Retype integrates advanced content search functionality, enabling developers to quickly locate the information they need.","Broken Link Detection: Retype's compilers swiftly identify any broken links (including anchors), ensuring that your documentation remains error-free.","Advanced Code Block Features: Retype's code blocks support features like line highlighting and optional titles, enhancing the presentation of code samples.","Outbound Links: Retype automatically identifies and manages external (outbound) links within the project, opening them in new tabs when clicked for a smoother user experience.","Multiple Layouts: Retype offers three distinct layouts out of the box: page, central, and blog, allowing flexibility in presentation.","Pages Visibility Control: Retype supports both Private& Protected pages, enabling controlled access to content.","Custom CSS: Retype allows to add custom global CSS and CSS classes to containers.","The Hub functionality: Retype's hub functionality enables the interlinking of multiple websites, facilitating seamless navigation between related resources.","By choosing Retype, we can take advantage of these features to enhance our documentation's organization, accessibility, and overall developers experience."]}],[{"l":"About","p":["To ask a question or propose an idea, feel free to start a new discussion on Github. If you found a bug, please open an issue on Github."]},{"l":"License","p":["See the LICENSE on Github."]}]] \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 8f0d38e..999495a 100644 Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ diff --git a/why-retype/index.html b/why-retype/index.html index ece1398..6c8d785 100644 --- a/why-retype/index.html +++ b/why-retype/index.html @@ -4,7 +4,7 @@ - + @@ -12,7 +12,7 @@ Why Retype over GitHub readme - + @@ -21,22 +21,22 @@ - + - + - + - + - + @@ -201,7 +201,7 @@

Why Retype over GitHub readme

-

While GitHub README.md files are great, there are a few advantages to use a documentation platform like Retype:

+

While GitHub README.md files are great, there are several compelling reasons to consider using a documentation platform like Retype:

  1. Better Structuring: Retype simplifies the organization of documentation by allowing easy division into multiple files and provides an intuitive navigation system with a left sidebar for seamless browsing.