Skip to content

Commit

Permalink
Merge pull request #88 from magento-devdocs/theme-update
Browse files Browse the repository at this point in the history
[DOC-299] Rebrand Merchdocs - Phase 1
  • Loading branch information
bdenham committed May 21, 2021
2 parents bdcc996 + 611cd11 commit c965fc4
Show file tree
Hide file tree
Showing 32 changed files with 182 additions and 157 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Contribute to Magento Merchant Documentation
## Contribute to the Merchant Documentation

Share your knowledge with the community by contributing to Magento Documentation!
You can contribute by creating an issue or pull request (PR) on our [MerchDocs](https://github.com/magento/merchdocs) GitHub repository.
Expand Down
6 changes: 3 additions & 3 deletions COPYING.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Copyright © 2013-present Magento, Inc.
Copyright © 2013-present Adobe, Inc.

Each Magento source file included in this distribution is licensed under OSL 3.0 or the Magento Enterprise Edition (MEE) license
Each Adobe source file included in this distribution is licensed under OSL 3.0

http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
Please see LICENSE.txt for the full text of the OSL 3.0 license or contact license@magentocommerce.com for a copy.

Subject to Licensee's payment of fees and compliance with the terms and conditions of the MEE License, the MEE License supersedes the OSL 3.0 license for each source file.
Please see LICENSE_EE.txt for the full text of the MEE License or visit http://magento.com/legal/terms/enterprise.
Please see LICENSE_EE.txt for the full text of the MEE License or visit http://magento.com/legal/terms/enterprise.
4 changes: 2 additions & 2 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
GIT
remote: https://github.com/magento-devdocs/devdocs-theme.git
revision: 0831f8f013f4c2e0ee829a5e8753b86601971806
revision: e061b241ec567a305ef6bf9620475cc85051b3d2
specs:
devdocs (14)
devdocs (15)
jekyll (>= 4.0)

GEM
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Magento Merchant Documentation
# Adobe Merchant Documentation

Welcome! This site contains the latest Magento merchant documentation for ongoing Magento 2.3.x releases. For additional information, see our [Contribution Guide](https://github.com/magento/merchdocs/blob/master/.github/CONTRIBUTING.md) and [Wiki](https://github.com/magento/merchdocs/wiki).
Welcome! This site contains the latest Adobe Commerce merchant documentation for ongoing Adobe Commerce and Magento Open Source 2.4.x and 2.3.x releases. For additional information, see our [Contribution Guide](https://github.com/magento/merchdocs/blob/master/.github/CONTRIBUTING.md) and [Wiki](https://github.com/magento/merchdocs/wiki).

## Contribute

Our goal is to provide the Magento Community with comprehensive and quality user documentation. We believe that to accomplish that goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving Magento documentation.
Our goal is to provide the Adobe Community with comprehensive and quality user documentation. We believe that to accomplish that goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving Adobe documentation.

Depending on your level of comfort, you may [clone this repo](#install-merchdocs), [make your changes](https://github.com/magento/merchdocs/wiki/Writing-Content#write-like-a-developer), and [build it locally](#build-locally), or [make changes directly in the GitHub user interface (UI)](https://github.com/magento/merchdocs/wiki/Writing-Content#write-in-github).

Expand Down
25 changes: 18 additions & 7 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# This file sets default project configuration for the User Guides website generator
# See default Jekyll configuration at https://jekyllrb.com/docs/configuration/default/

title: Magento 2.4 User Guide
title: Adobe Commerce 2.4 User Guide

description: Merchant-focused documentation for both Magento Commerce and Magento Open Source
logo: Magento User Guide
description: Merchant-focused documentation for both Adobe Commerce and Magento Open Source
logo: Commerce User Guide
baseurl: /user-guide
url: "https://docs.magento.com"
destination: _site/user-guide
Expand All @@ -17,19 +17,19 @@ source: src
plugins_dir: ./_plugins

version: 2.4
versions:
-
versions:
-
name: "2.4"
url: "/user-guide"
-
-
name: "2.3"
url: "/user-guide/v2.3"


algolia:
application_id: E642SEDTHL
index_name: merchdocs

api_key: d2d0f33ab73e291ef8d88d8b565e754c

google:
Expand Down Expand Up @@ -156,3 +156,14 @@ livereload: true
check_links: true

devdocs_url: https://devdocs.magento.com

# This addition fixes a bug in the copy.js of devdocs-theme
#
kramdown:
toc_levels: 2..3
syntax_highlighter_opts:
css_class: highlighter
span:
line_numbers: false
block:
line_numbers: true
4 changes: 2 additions & 2 deletions src/_data/home-sections.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- title: New to Magento?
- title: New to Adobe Commerce?
content: Discover resources available to members of the Magento ecosystem. Follow the customer journey to explore your store, and learn about key features.
url: /getting-started.html

Expand Down Expand Up @@ -32,4 +32,4 @@

- title: Share your knowledge
content: Become a Magento documentation contributor by suggesting improvements, logging issues, and submitting revisions to our open source documentation repository.
url: /getting-started/contribute.html
url: /getting-started/contribute.html
6 changes: 3 additions & 3 deletions src/_data/main-nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- label: About This Release
url: "/magento/about-this-release.html"

- label: Your Magento Account
- label: Your Commerce Account
url: "/magento/magento-account.html"

- label: " Quick Tour"
Expand All @@ -15,14 +15,14 @@
- label: Basic Configuration
url: /configuration/configuration-basic.html

- label: Magento Extensions
- label: Extensions
url: /magento/magento-extensions.html

- label: Magento Marketplace
url: /magento/magento-marketplace.html

- label: Magento Identity Manager
url: /magento/magento-identity-manager.html
url: /magento/magento-identity-manager.html

- label: Resources
url: "/getting-started/resources.html"
Expand Down
2 changes: 1 addition & 1 deletion src/_data/toc/config-ref.yml
Original file line number Diff line number Diff line change
Expand Up @@ -204,4 +204,4 @@ pages:
- label: System
url: "/configuration/advanced/system.html"
- label: Developer
url: "/configuration/advanced/developer.html"
url: "/configuration/advanced/developer.html"
12 changes: 6 additions & 6 deletions src/_data/toc/getting-started.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ pages:
url: "/magento/prelaunch-checklist.html"
- label: Your Login Credentials
url: "/getting-started/login-credentials.html"
- label: Your Magento Account
- label: Your Commerce Account
url: "/magento/magento-account.html"
children:
- label: Creating an Account
Expand Down Expand Up @@ -58,7 +58,7 @@ pages:
edition: b2b-only
children:
- label: B2B Best Practices
url: "/stores/b2b-best-practices.html"
url: "/stores/b2b-best-practices.html"
- label: Build Loyalty
url: "/quick-tour/build-loyalty.html"
- label: Differentiate and Personalize
Expand Down Expand Up @@ -193,7 +193,7 @@ pages:
url: "/stores/compliance-ccpa-guide.html"
- label: GDPR Compliance
versionless: true
url: "/stores/compliance-gdpr.html"
url: "/stores/compliance-gdpr.html"
- label: Privacy Policy
versionless: true
url: "/stores/privacy-policy.html"
Expand All @@ -207,20 +207,20 @@ pages:
- label: Cookie Reference
versionless: true
url: "/stores/cookie-reference.html"
- label: Magento Extensions
- label: Extensions
url: "/magento/magento-extensions.html"
- label: Magento Marketplace
url: "/magento/magento-marketplace.html"
- label: Magento Identity Manager
url: "/magento/magento-identity-manager.html"
- label: Resources
url: "/getting-started/resources.html"
children:
children:
- label: Join the Conversation
url: "/getting-started/magento-ecosystem.html"
- label: Technical Resources
url: https://magento.com/technical-resources
- label: What’s New in the User Guide
url: "/whats-new.html"
- label: Contribute to the Docs
url: "/getting-started/contribute.html"
url: "/getting-started/contribute.html"
6 changes: 3 additions & 3 deletions src/_data/toc/marketing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ pages:
url: "/sales-channels/asc/about-amazon-sales-channel.html"
- label: About Amazon Marketplace
url: "/sales-channels/asc/about-amazon-marketplace.html"
- label: About Amazon and your Magento Catalog
- label: About Amazon and your Commerce Catalog
url: "/sales-channels/asc/about-listings-and-catalog.html"
- label: Best Practices and Limitations
url: "/sales-channels/asc/amazon-best-practices.html"
Expand All @@ -29,7 +29,7 @@ pages:
- label: Pre-Setup Tasks
url: "/sales-channels/asc/amazon-pre-setup-tasks.html"
children:
- label: Create Magento Attributes for Amazon
- label: Create Commerce Attributes for Amazon
url: "/sales-channels/asc/ob-creating-magento-attributes.html"
- label: Verify the Amazon API Key
url: "/sales-channels/asc/amazon-verify-api-key.html"
Expand Down Expand Up @@ -61,7 +61,7 @@ pages:
- label: Amazon Store Dashboard
url: "/sales-channels/asc/amazon-store-dashboard.html"
- label: Manage Store Settings
url: "/sales-channels/asc/ob-store-review.html"
url: "/sales-channels/asc/ob-store-review.html"
children:
- label: Listing Settings
url: "/sales-channels/asc/listing-settings.html"
Expand Down
8 changes: 4 additions & 4 deletions src/_data/var.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
# Product Name variables

ce: Magento Open Source
ee: Magento Commerce
b2b: Magento Commerce for B2B
mbi: Magento Business Intelligence
ee: Adobe Commerce
b2b: B2B for Adobe Commerce
mbi: Adobe Commerce Reporting

# Cloud product name variables
ece: Magento Commerce Cloud
ece: Adobe Commerce for Cloud
ct: ece-tools

# TIP: Use the following syntax to use a variable in the documentation source: {{site.data.var.xx}} where xx
Expand Down
42 changes: 27 additions & 15 deletions src/_includes/layout/header-scripts.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,31 @@
<script>
var baseUrl = "{{ site.baseurl }}";
var algolia = {
id : "{{ site.algolia.application_id }}",
id: "{{ site.algolia.application_id }}",
index: "{{ site.algolia.index_name }}",
key: "{{ site.algolia.api_key }}"
};

var indices = [
{
var indices = [{
label: "User Guide",
name: "{{ site.algolia.index_name }}",
baseUrl: "{{ site.baseurl }}"
},
{
label: "MBI User Guide",
label: "Commerce Reporting User Guide",
name: "merchdocs-mbi",
baseUrl: "https://docs.magento.com/mbi"
},
{
label: "DevDocs",
name: "devdocs",
facetFilters: [["guide_version: 2.3", "versionless: true"]],
refinements: [
{
label: "Functional areas",
attribute: "functional_areas"
}
facetFilters: [
["guide_version: 2.3", "versionless: true"]
],
refinements: [{
label: "Functional areas",
attribute: "functional_areas"
}],
baseUrl: "https://devdocs.magento.com"
},
{
Expand All @@ -41,16 +40,29 @@
baseUrl: "https://omsdocs.magento.com"
}
];

</script>

{% if site.environment == "public" %}

<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','{{ site.google.gtm }}');</script>
<script>
(function (w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({
'gtm.start': new Date().getTime(),
event: 'gtm.js'
});
var f = d.getElementsByTagName(s)[0],
j = d.createElement(s),
dl = l != 'dataLayer' ? '&l=' + l : '';
j.async = true;
j.src =
'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, 'script', 'dataLayer', '{{ site.google.gtm }}');

</script>
<!-- End Google Tag Manager -->

{% endif %}
10 changes: 5 additions & 5 deletions src/_includes/layout/nav-item.html
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@

{% assign item = include.section %}
{% assign children = item.children %}

{% assign base = site.baseurl %}
{% if item.url contains 'http' %}
{% assign base = '' %}
{% assign base = '' %}
{% endif %}

{% assign item_url = item.url | prepend: base %}
{% assign compare_url = page.url | prepend: site.baseurl %}
<li class="{% if compare_url == item_url %}is-selected{% endif %} {{ item.class }} {{ include.itemClass }}" role="menuitem">
<li class="{% if compare_url == item_url %}is-selected{% endif %} {{ item.class }} {{ include.itemClass }}"
role="menuitem">
{% if item.url %}
<a href="{{ item_url }}" class="{{ include.labelClass }} {{ item.edition }}">{{ item.label }}</a>
{% else %}
<span class="{{ include.labelClass }} {{ item.edition }}">{{ item.label }}</span>
{% endif %}
{% if children %}
<ul class="{{ include.menuClass }}">
<ul class="spectrum-SideNav">
{% for child in children %}
{% include layout/nav-item.html section=child menuClass=include.menuClass itemClass=include.itemClass labelClass=include.labelClass %}
{% include layout/nav-item.html section=child menuClass=include.menuClass itemClass=include.itemClass labelClass=include.labelClass %}
{% endfor %}
</ul>
{% endif %}
Expand Down
Loading

0 comments on commit c965fc4

Please sign in to comment.