Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

About spryker #2550

Merged
merged 39 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
ffca5f0
move docs
andriitserkovnyi Mar 1, 2024
144f4e9
move docs
andriitserkovnyi Mar 4, 2024
2a59053
redirects
andriitserkovnyi Mar 5, 2024
7333468
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 6, 2024
c028815
rename
andriitserkovnyi Mar 6, 2024
ac8af81
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 7, 2024
a979a75
rename
andriitserkovnyi Mar 7, 2024
44426f7
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 8, 2024
de6a287
rename
andriitserkovnyi Mar 8, 2024
24105c0
sidebar
andriitserkovnyi Mar 8, 2024
13eaa75
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 12, 2024
4b2e1e8
merge master
andriitserkovnyi Mar 12, 2024
313cdee
links
andriitserkovnyi Mar 12, 2024
2ddc0e7
links
andriitserkovnyi Mar 12, 2024
08ed995
Update about-spryker.md
andriitserkovnyi Mar 12, 2024
dd72a21
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 12, 2024
7ed7279
Update about-spryker.md
andriitserkovnyi Mar 12, 2024
15a73d5
Update about-spryker.md
andriitserkovnyi Mar 12, 2024
8991b50
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 12, 2024
9564337
links
andriitserkovnyi Mar 12, 2024
1a00f81
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 14, 2024
6be71f1
links
andriitserkovnyi Mar 14, 2024
b3b738b
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 18, 2024
8f2a3e7
links
andriitserkovnyi Mar 18, 2024
afdad8e
links
andriitserkovnyi Mar 18, 2024
ddece67
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 19, 2024
e9adb1b
links
andriitserkovnyi Mar 19, 2024
ae6fe1a
links
andriitserkovnyi Mar 19, 2024
f3e3596
sidebar
andriitserkovnyi Mar 20, 2024
1ceaafa
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 21, 2024
0ba1dd0
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 22, 2024
9a3a852
sidebar
andriitserkovnyi Mar 22, 2024
b7b201b
links
andriitserkovnyi Mar 22, 2024
d089ce6
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 25, 2024
774cb67
links
andriitserkovnyi Mar 25, 2024
7514a0a
links
andriitserkovnyi Mar 25, 2024
561bc01
Merge branch 'master' into about-spryker
andriitserkovnyi Mar 25, 2024
c888417
Update dg_dev_sidebar.yml
andriitserkovnyi Mar 25, 2024
555b2f7
links
andriitserkovnyi Mar 25, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ jobs:
name: build-result
path: result.tar.gz

link_validation_check_ca:
name: Links validation (check_ca)
link_validation_check_about:
name: Links validation (check_about)
needs: jekyll_build
runs-on: ubuntu-latest

Expand All @@ -52,17 +52,17 @@ jobs:
uses: actions/cache@v2
with:
path: tmp/.htmlproofer
key: ${{ runner.os }}-check_cloud-htmlproofer
key: ${{ runner.os }}-check_about_all-htmlproofer

- uses: actions/download-artifact@v2

- name: Unpack artifacts
run: tar -xf build-result/result.tar.gz

- run: bundle exec rake check_ca
- run: bundle exec rake check_about

link_validation_check_scos_user:
name: Links validation (check_scos_user)
link_validation_check_ca:
name: Links validation (check_ca)
needs: jekyll_build
runs-on: ubuntu-latest

Expand All @@ -80,14 +80,14 @@ jobs:
uses: actions/cache@v2
with:
path: tmp/.htmlproofer
key: ${{ runner.os }}-check_scos_user-htmlproofer
key: ${{ runner.os }}-check_cloud-htmlproofer

- uses: actions/download-artifact@v2

- name: Unpack artifacts
run: tar -xf build-result/result.tar.gz

- run: bundle exec rake check_scos_user
- run: bundle exec rake check_ca

link_validation_check_pbc:
name: Links validation (check_pbc)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To build the documentation site with Docker, run this command:

## Contribute

For the specific Markdown syntax we use in documentation, see [Markdown syntax](/docs/scos/user/intro-to-spryker/contributing-to-documentation/markdown-syntax.html). For the general style, syntax, and formatting rules, see [Style, syntax, formatting, and general rules](/docs/scos/user/intro-to-spryker/contributing-to-documentation/style-formatting-general-rules.html).
For the specific Markdown syntax we use in documentation, see [Markdown syntax](/docs/about/all/contributing-to-documentation/markdown-syntax.html). For the general style, syntax, and formatting rules, see [Style, syntax, formatting, and general rules](/docs/about/all/contributing-to-documentation/style-formatting-general-rules.html).

To suggest changes, follow the steps:

Expand Down
16 changes: 5 additions & 11 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -86,30 +86,22 @@ task :check_ca do
/docs\/scos\/.+/,
/docs\/fes\/.+/,
/docs\/pbc\/.+/,
/docs\/about\/.+/,
/docs\/dg\/.+/,
/docs\/acp\/.+/
]
HTMLProofer.check_directory("./_site", options).run
end

task :check_scos_user do
task :check_about do
options = commonOptions.dup
options[:ignore_files] = [
/docs\/ca\/.+/,
/docs\/acp\/.+/,
/docs\/scos\/dev\/.+/,
/docs\/fes\/.+/,
/docs\/pbc\/.+/,
/docs\/dg\/.+/,
/docs\/scos\/\w+\/[\w-]+\/201811\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/201903\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/201907\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202001\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202005\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202009\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202108\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202204\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202400\.0\/.+/
/docs\/dg\/.+/
]
HTMLProofer.check_directory("./_site", options).run
end
Expand All @@ -118,6 +110,7 @@ task :check_pbc do
options = commonOptions.dup
options[:ignore_files] = [
/docs\/scos\/.+/,
/docs\/about\/.+/,
/docs\/ca\/.+/,
/docs\/fes\/.+/,
/docs\/acp\/.+/,
Expand All @@ -139,6 +132,7 @@ task :check_dg do
/docs\/scos\/.+/,
/docs\/ca\/.+/,
/docs\/acp\/.+/,
/docs\/about\/.+/,
/docs\/fes\/.+/,
/docs\/pbc\/.+/,
/docs\/dg\/\w+\/[\w-]+\/202212\.0\/.+/,
Expand Down
24 changes: 12 additions & 12 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,6 @@ defaults:
path: "docs/"
values:
feed: true
-
scope:
path: "docs/scos"
values:
product: "scos"
-
scope:
path: "docs/scos/user"
values:
sidebar: "scos_user_sidebar"
role: "user"
-
scope:
path: "docs/ca"
Expand Down Expand Up @@ -131,6 +120,17 @@ defaults:
values:
sidebar: "pbc_all_sidebar"
role: "all"
-
scope:
path: "docs/about"
values:
product: "about"
-
scope:
path: "docs/about/all"
values:
sidebar: "about_all_sidebar"
role: "all"

versions:
'202212.0': '202212.0'
Expand Down Expand Up @@ -184,8 +184,8 @@ versioned_categories:
sidebars:
- ca_dev_sidebar
- ca_devscu_sidebar
- scos_user_sidebar
- pbc_all_sidebar
- about_all_sidebar
- dg_dev_sidebar

description: "Spryker documentation center."
Expand Down
143 changes: 143 additions & 0 deletions _data/sidebars/about_all_sidebar.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
title: About Spryker
entries:
- product: About Spryker
nested:
- title: About Spryker
url: /docs/about/all/about-spryker.html
- title: Releases
url: /docs/about/all/releases/product-and-code-releases.html
nested:
- title: Security release notes 202312.0
url: /docs/about/all/releases/security-release-notes-202312.0.html
- title: Release notes 202311.0
url: /docs/about/all/releases/release-notes-202311.0.html
- title: Security release notes 202309.0
url: /docs/about/all/releases/security-release-notes-202309.0.html
- title: Release notes 202307.0
url: /docs/about/all/releases/release-notes-202307.0/release-notes-202307.0.html
nested:
- title: Security release notes 202307.0
url: /docs/about/all/releases/release-notes-202307.0/security-release-notes-202307.0.html
- title: Security release notes 202306.0
url: /docs/about/all/releases/security-release-notes-202306.0.html
- title: Security release notes 202304.0
url: /docs/about/all/releases/security-release-notes-202304.0.html
- title: Security release notes 202302.0
url: /docs/about/all/releases/security-release-notes-202302.0.html
- title: Release notes 202212.0
url: /docs/about/all/releases/release-notes-202212.0/release-notes-202212.0.html
nested:
- title: Patch releases 202212.0
url: /docs/about/all/releases/release-notes-202212.0/patch-release-notes-202212.0.html
- title: Security release notes 202212.0
url: /docs/about/all/releases/release-notes-202212.0/security-release-notes-202212.0.html
- title: Release notes 202211.0
url: /docs/about/all/releases/release-notes-202211.0.html

- title: Security audit reports
nested:
- title: 2019.11 - Security audit by SektionEins
url: /docs/about/all/security-audit-reports/2019.11-security-audit-by-sektioneins.html
- title: 2020.11 - Penetration test by Port Zero (executive summary)
url: /docs/about/all/security-audit-reports/2020.11-penetration-test-by-port-zero-executive-summary.html

- title: Support
url: /docs/about/all/support/getting-support.html
nested:
- title: How Spryker Support works
url: /docs/about/all/support/how-spryker-support-works.html
- title: Support case escalations
url: /docs/about/all/support/support-case-escalations.html
- title: Preparing for heavy loads and traffic
url: /docs/about/all/support/preparing-for-heavy-loads-and-traffic.html
- title: How to use the Support Portal
url: /docs/about/all/support/using-the-support-portal.html
- title: Share secrets with the Spryker Support Team
url: /docs/about/all/support/share-secrets-with-the-spryker-support-team.html
- title: Understanding ticket status
url: /docs/about/all/support/support-ticket-statuses.html
- title: Handling security issues
url: /docs/about/all/support/reporting-and-handling-security-issues.html
- title: Guidelines for GDPR compliance
url: /docs/about/all/support/guidelines-for-gdpr-compliance.html
- title: Getting the most out of Spryker Support
url: /docs/about/all/support/getting-the-most-out-of-spryker-support.html
- title: Understand SLAs
url: /docs/about/all/support/understanding-slas.html
- title: Escalations
url: /docs/about/all/support/support-case-escalations.html
- title: Prioritizing support cases
url: /docs/about/all/support/prioritzing-support-cases.html
- title: Understanding project and core level fixes
url: /docs/about/all/support/project-level-and-core-level-fixes.html

- title: Supported browsers
url: /docs/about/all/supported-browsers.html
- title: Master Suite
url: /docs/about/all/master-suite.html
- title: B2C Suite
url: /docs/about/all/b2c-suite.html
- title: B2B Suite
url: /docs/about/all/b2b-suite.html

- title: Spryker Marketplace
url: /docs/about/all/spryker-marketplace/spryker-marketplace.html
nested:
- title: Marketplace concept
url: /docs/about/all/spryker-marketplace/marketplace-concept.html
- title: Marketplace personas
url: /docs/about/all/spryker-marketplace/marketplace-personas.html
- title: Back Office for Marketplace Operator
url: /docs/about/all/spryker-marketplace/back-office-for-marketplace-operator.html
- title: Merchant onboarding
url: /docs/about/all/spryker-marketplace/merchant-onboarding.html
- title: Marketplace Storefront
url: /docs/about/all/spryker-marketplace/marketplace-storefront.html
- title: Merchant Portal
url: /docs/about/all/spryker-marketplace/merchant-portal.html
- title: Marketplace B2C Suite
url: /docs/about/all/spryker-marketplace/marketplace-b2c-suite.html
- title: Marketplace B2B Suite
url: /docs/about/all/spryker-marketplace/marketplace-b2b-suite.html

- title: About the docs
url: /docs/about/all/about-the-docs/about-spryker-docs.html
nested:
- title: Docs updates
url: /docs/about/all/about-the-docs/docs-updates.html
- title: Contribute
url: /docs/about/all/about-the-docs/contribute-to-the-docs/contribute-to-the-docs.html
nested:
- title: Edit using a web browser
url: /docs/about/all/about-the-docs/contribute-to-the-docs/edit-the-docs-using-a-web-browser.html
- title: Edit locally
url: /docs/about/all/about-the-docs/contribute-to-the-docs/edit-the-docs-locally.html
- title: Add and edit diagrams
url: /docs/about/all/about-the-docs/contribute-to-the-docs/add-and-edit-diagrams-in-the-docs.html
- title: Report issues
url: /docs/about/all/about-the-docs/contribute-to-the-docs/report-docs-issues.html
- title: Review pull requests
url: /docs/about/all/about-the-docs/contribute-to-the-docs/review-docs-pull-requests.html
- title: Add global sections
url: /docs/about/all/about-the-docs/contribute-to-the-docs/add-global-sections-to-the-docs.html
- title: Install recommended VS Code extensions
url: /docs/about/all/about-the-docs/contribute-to-the-docs/install-recommended-vs-code-extensions.html

- title: Style guide
url: /docs/about/all/about-the-docs/style-guide/spryker-docs-style-guide.html
nested:
- title: Examples
url: /docs/about/all/about-the-docs/style-guide/style-guide-examples.html
- title: Spelling
url: /docs/about/all/about-the-docs/style-guide/style-guide-spelling.html
- title: Word list
url: /docs/about/all/about-the-docs/style-guide/word-list.html
- title: General rules and guidance for adding docs
url: /docs/about/all/about-the-docs/style-guide/general-rules-and-guidance-for-adding-docs.html
- title: Markdown syntax
url: /docs/about/all/about-the-docs/style-guide/markdown-syntax.html

- title: Run the docs locally
url: /docs/about/all/about-the-docs/run-the-docs-locally.html

...
10 changes: 8 additions & 2 deletions _data/sidebars/dg_dev_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -811,6 +811,8 @@ entries:
url: /docs/dg/dev/upgrade-and-migrate/upgrade-to-angular-12.html
- title: Upgrade to Angular 15
url: /docs/dg/dev/upgrade-and-migrate/upgrade-to-angular-15.html
- title: Upgrade to PHP 8.1
url: /docs/dg/dev/upgrade-and-migrate/upgrade-to-php-81.html
- title: Upgrade to Symfony 5
url: /docs/dg/dev/upgrade-and-migrate/upgrade-to-symfony-5.html
- title: Upgrade to Symfony 6
Expand Down Expand Up @@ -1298,7 +1300,8 @@ entries:
url: /docs/dg/dev/troubleshooting/troubleshooting-general-technical-issues/class-silex-controllerproviderinterface-not-found.html
- title: Error response from daemon - OCI runtime create failed - .... \\\"no such file or directory\\\"\""- unknown
url: /docs/dg/dev/troubleshooting/troubleshooting-general-technical-issues/error-response-from-daemon-oci-runtime-create-failed-no-such-file-or-directory-unknown.html

- title: Prices filter and sorting doesn't work on Frontend
url: /docs/dg/dev/troubleshooting/troubleshooting-general-technical-issues/prices-filter-and-sorting-does-t-work-on-frontend.html
- title: Router generates absolute URL with localhost
url: /docs/dg/dev/troubleshooting/troubleshooting-general-technical-issues/router-generates-absolute-url-with-localhost.html
- title: No data on the Storefront
Expand Down Expand Up @@ -1403,9 +1406,10 @@ entries:
include_versions:
- "202212.0"
- title: Resolve search engine friendly URLs
url: /docs/dg/dev/glue-api/old-glue-infrastructure/glue-api-resolve-search-engine-friendly-urls.html
url: /docs/dg/dev/glue-api/202212.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.html
include_versions:
- "202212.0"
- "202307.0"
- title: "Marketplace: Resolve search engine friendly URLs"
url: /docs/dg/dev/glue-api/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.html
- title: Reference information - GlueApplication errors
Expand Down Expand Up @@ -1572,3 +1576,5 @@ entries:
url: /docs/dg/dev/code-generator.html
- title: Example modules
url: /docs/dg/dev/example-modules.html
- title: Supported versions of PHP
url: /docs/dg/dev/supported-versions-of-php.html
Loading
Loading