Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Commit

Permalink
Refactor TOC generation
Browse files Browse the repository at this point in the history
The TOC has been refactored to use pre-set data files instead of
calculating it during build time.

This effectively cuts the build time in half and makes it easier to
modify the table of contents.
  • Loading branch information
James Calcaben committed Sep 28, 2017
1 parent b53bbcb commit 7d22f03
Show file tree
Hide file tree
Showing 37 changed files with 3,607 additions and 110 deletions.
114 changes: 114 additions & 0 deletions _data/toc/admin-pattern-library.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
label: Admin Pattern Library
pages:
- label: Introduction
url: pattern-library/bk-pattern.html
- label: Container
children:

- label: Static Content Container
url: pattern-library/containers/staticContentContainer/contentContainer.html

- label: Slide-out, Modals, and Overlays
url: pattern-library/containers/slideouts-modals-overlays/slideouts-modals-overalys.html

- label: Tabs
url: pattern-library/containers/tabs/tabs.html

- label: Controls
children:

- label: Buttons
url: pattern-library/controls/buttons/buttons.html

- label: Button Bar
url: pattern-library/controls/button-bar/button-bar.html

- label: Expandable Sections
versions: ["2.1","2.2"]
url: pattern-library/controls/Expandable_Sections/expand-collapse.html

- label: View Controller
versions: ["2.1","2.2"]
url: pattern-library/controls/viewcontroller/viewcontroller.html

- label: Displaying and Dealing with Data
children:

- label: Filters
url: pattern-library/filters/data-table-filters/filtering.html

- label: Tile
url: pattern-library/displaying-data/tile/tile.html

- label: Data Table
url: pattern-library/displaying-data/datatable/datatable.html

- label: Tree
url: pattern-library/displaying-data/tree/tree.html

- label: Feedback to User
children:

- label: Progress Indicator
url: pattern-library/feedbackToUser/progressIndicator/progressIndicator.html

- label: General
children:

- label: Accessibility Guideline
url: pattern-library/general/accessibilityguideline/accessibilityGuideline.html

- label: Getting User Input
children:

- label: Form Elements
url: pattern-library/getting-user-input/form_elements/form_elements.html

- label: Image Uploader
url: pattern-library/getting-user-input/image_uploader/image_uploader.html

- label: Date and Time Selector
url: pattern-library/getting-user-input/date_time_selector/date_time_selector.html

- label: Row Pattern (Table)
url: pattern-library/getting-user-input/row_pattern/row_pattern.html

- label: Use Default Config
url: pattern-library/getting-user-input/use_default_config/use_default_config.html

- label: Select From List
url: pattern-library/getting-user-input/select_from_list/select_from_list.html

- label: Graphics
children:

- label: Iconography
url: pattern-library/graphics/iconography/iconography.html

- label: Navigation
children:

- label: Links
url: pattern-library/navigation/links/links.html

- label: Wizard
url: pattern-library/navigation/wizard/wizard.html

- label: Staging Patterns
versions: ["2.1","2.2"]
children:

- label: Timeline Dashboard
url: pattern-library/staging-patterns/TimelineDashboard/Timeline-Dashboard.html

- label: Scheduled Changes Module
url: pattern-library/staging-patterns/ScheduledChangesModule/module.html

- label: Templates
children:

- label: Address Form
url: pattern-library/templates/address-form/address-form.html

- label: Sign In Form
url: pattern-library/templates/sign-in-form/sign-in-form.html
46 changes: 46 additions & 0 deletions _data/toc/admin-style-guide.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
label: Admin Style Guide
pages:
- label: Admin Style Guide
children:

- label: Introduction
url: design-styleguide/bk-styleguide.html

- label: Design
children:

- label: Color
url: design-styleguide/color/color.html

- label: Iconography
url: design-styleguide/iconography/iconography.html

- label: Page Grids
url: design-styleguide/pagegrid/pagegrid.html

- label: Typography
url: design-styleguide/typography/typography.html

- label: Writing and Content
children:

- label: Voice and Tone
url: design-styleguide/content-voide-tone/content-voice-tone.html

- label: Errors and Messages Writing
url: design-styleguide/errors-and-messages/errors-and-messages.html

- label: Buttons and Links Usage
url: design-styleguide/buttons-and-links-usage/buttons-and-links-usage.html

- label: Capitalization
url: design-styleguide/capitalization/capitalization.html

- label: Headings and Organization
url: design-styleguide/headings-and-organization/headings-and-organization.html

- label: Content Formats
url: design-styleguide/content-formats/content-formats.html

- label: Number Formats
url: design-styleguide/number-formats/number-formats.html
73 changes: 73 additions & 0 deletions _data/toc/architecture-guide.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
label: Architecture Guide
pages:
- label: Introduction
url: architecture/bk-architecture.html

- label: Architectural basics
url: architecture/archi_perspectives/ABasics_intro.html
children:

- label: Extensibility and modularity
url: architecture/extensibility.html

- label: Ease of frontend customization
url: architecture/frontend_custom_strategies.html

- label: Global features that support extensibility
url: architecture/global_extensibility_features.html

- label: Security
url: architecture/security_intro.html

- label: Storefront customization strategies
url: architecture/storefront_customization.html

- label: Architectural diagrams
url: architecture/archi_perspectives/arch_diagrams.html

- label: Technology stack
url: architecture/tech-stack.html

- label: Architectural layers
url: architecture/archi_perspectives/ALayers_intro.html
children:

- label: Presentation layer
url: architecture/archi_perspectives/present_layer.html

- label: Service layer
url: architecture/archi_perspectives/service_layer.html

- label: Domain layer
url: architecture/archi_perspectives/domain_layer.html

- label: Persistence layer
url: architecture/archi_perspectives/persist_layer.html

- label: Components
url: architecture/archi_perspectives/components/AComponents.html
children:

- label: Module overview
url: architecture/archi_perspectives/components/modules/mod_intro.html

- label: Modules and areas
url: architecture/archi_perspectives/components/modules/mod_and_areas.html

- label: Module conventions
url: architecture/archi_perspectives/components/modules/mod_conventions.html

- label: Module relationships
url: architecture/archi_perspectives/components/modules/mod_relationships.html

- label: Module dependencies
url: architecture/archi_perspectives/components/modules/mod_depend.html

- label: Module dependency types
url: architecture/archi_perspectives/components/modules/mod_depend_types.html

- label: Magento Framework
url: architecture/archi_perspectives/framework.html

- label: Third-party libraries
url: architecture/archi_perspectives/third-party-libs.html
70 changes: 70 additions & 0 deletions _data/toc/b2b-developer-guide.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
label: B2B Developer Guide
pages:

- label: Introduction
url: b2b/bk-b2b.html

- label: Integrate with B2B using REST
url: b2b/integrations.html
children:

- label: Company
children:

- label: Integrate with the Company module
url: b2b/company.html

- label: Manage company objects
url: b2b/company-object.html

- label: Manage company users
url: b2b/company-users.html

- label: Manage company roles
url: b2b/roles.html

- label: Manage company structures
url: b2b/company-structures.html

- label: Company credit
children:

- label: Integrate with the CompanyCredit module
url: b2b/company-credit.html

- label: Manage company credit
url: b2b/credit-manage.html

- label: Shared Catalog
children:

- label: Integrate with the SharedCatalog module
url: b2b/shared-catalog.html

- label: Manage shared catalogs
url: b2b/shared-cat-manage.html

- label: Assign categories and products
url: b2b/shared-cat-product-assign.html

- label: Assign companies
url: b2b/shared-cat-company.html

- label: Negotiable Quotes
children:

- label: Integrate with the NegotiableQuote module
url: b2b/negotiable-quote.html

- label: Manage negotiable quotes
url: b2b/negotiable-manage.html

- label: Update a negotiable quote
url: b2b/negotiable-update.html

- label: Negotiable quote checkout
url: b2b/negotiable-checkout.html

- label: Develop B2B extensions
url: b2b/extensions.html

Loading

0 comments on commit 7d22f03

Please sign in to comment.