documentation-developer icon indicating copy to clipboard operation
documentation-developer copied to clipboard

Wrong yaml config in "Create custom taxonomy" example

Open vidarl opened this issue 6 months ago • 2 comments

Question Answer
JIRA Ticket N/A)
Versions 4.6
Edition Experience

This is fix for the page : https://doc.ibexa.co/en/latest/content_management/taxonomy/taxonomy/#customize-taxonomy-structure

The docs instructs you to name that field "name", but this doesn't match the config presented : https://github.com/ibexa/documentation-developer/blob/bb643999f925210719dc995b6839d616d8c87354/docs/content_management/taxonomy/taxonomy.md?plain=1#L50

Note that the instructions still doesn't work as listed due to IBX-8420

Work-around is to do this after the content type with content_category identifier as been created:

  1. Comment out new taxonomy config in yaml
  2. Attempt to create that "root" content in admin-ui. Draft will be created, but TaxonomyNotFoundException will be thrown due to missing yaml config. So you won't be able to edit and publish the draft
  3. Re-enable yaml config
  4. Go to dashboard
  5. Edit draft of the "Content category" which was just created

Then continue from "Finish taxonomy setup by creating a new Content category (...)" as described in the docs

Not sure if we should add the bullet list above to the documentation until IBX-8420 has been fixed?

Checklist

  • [ ] Text renders correctly
  • [ ] Text has been checked with vale
  • [ ] Description metadata is up to date
  • [ ] Redirects cover removed/moved pages
  • [ ] Code samples are working
  • [ ] PHP code samples have been fixed with PHP CS fixer
  • [ ] Added link to this PR in relevant JIRA ticket or code PR

vidarl avatar May 06 '25 12:05 vidarl

Preview of modified files: no change to preview.

github-actions[bot] avatar May 06 '25 12:05 github-actions[bot]

code_samples/ change report

Before (on target branch)After (in current PR)

code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml

docs/content_management/taxonomy/taxonomy.md@14:``` yaml
docs/content_management/taxonomy/taxonomy.md@15:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 0, 9) =]]
docs/content_management/taxonomy/taxonomy.md@16:```

001⫶ibexa_taxonomy:
002⫶ taxonomies:
003⫶ tags:
004⫶ parent_location_remote_id: taxonomy_tags_folder
005⫶ content_type: tag
006⫶ field_mappings:
007⫶ identifier: identifier
008⫶ parent: parent
009⫶ name: name

docs/content_management/taxonomy/taxonomy.md@36:``` yaml
docs/content_management/taxonomy/taxonomy.md@37:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 0, 2) =]] # existing keys
docs/content_management/taxonomy/taxonomy.md@38:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 9, 17) =]]
docs/content_management/taxonomy/taxonomy.md@39:```

001⫶ibexa_taxonomy:
002⫶ taxonomies:
003⫶ # existing keys
004⫶ content_categories:
005⫶ parent_location_remote_id: <content_categories_remote_id>
006⫶ content_type: content_category
007⫶ field_mappings:
008⫶ identifier: category_identifier
009⫶ parent: parent_category

code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml

docs/content_management/taxonomy/taxonomy.md@14:``` yaml
docs/content_management/taxonomy/taxonomy.md@15:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 0, 9) =]]
docs/content_management/taxonomy/taxonomy.md@16:```

001⫶ibexa_taxonomy:
002⫶ taxonomies:
003⫶ tags:
004⫶ parent_location_remote_id: taxonomy_tags_folder
005⫶ content_type: tag
006⫶ field_mappings:
007⫶ identifier: identifier
008⫶ parent: parent
009⫶ name: name

docs/content_management/taxonomy/taxonomy.md@36:``` yaml
docs/content_management/taxonomy/taxonomy.md@37:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 0, 2) =]] # existing keys
docs/content_management/taxonomy/taxonomy.md@38:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 9, 17) =]]
docs/content_management/taxonomy/taxonomy.md@39:```

001⫶ibexa_taxonomy:
002⫶ taxonomies:
003⫶ # existing keys
004⫶ content_categories:
005⫶ parent_location_remote_id: <content_categories_remote_id>
006⫶ content_type: content_category
007⫶ field_mappings:
008⫶ identifier: category_identifier
009⫶ parent: parent_category
010⫶                name: name_field
010⫶                name: name
011⫶            assigned_content_tab: false

docs/content_management/taxonomy/taxonomy.md@65:``` yaml
docs/content_management/taxonomy/taxonomy.md@66:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 0, 2) =]] # existing keys
docs/content_management/taxonomy/taxonomy.md@67:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 9, 17) =]]
docs/content_management/taxonomy/taxonomy.md@68:```

001⫶ibexa_taxonomy:
002⫶ taxonomies:
003⫶ # existing keys
004⫶ content_categories:
005⫶ parent_location_remote_id: <content_categories_remote_id>
006⫶ content_type: content_category
007⫶ field_mappings:
008⫶ identifier: category_identifier
009⫶ parent: parent_category
011⫶            assigned_content_tab: false

docs/content_management/taxonomy/taxonomy.md@65:``` yaml
docs/content_management/taxonomy/taxonomy.md@66:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 0, 2) =]] # existing keys
docs/content_management/taxonomy/taxonomy.md@67:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 9, 17) =]]
docs/content_management/taxonomy/taxonomy.md@68:```

001⫶ibexa_taxonomy:
002⫶ taxonomies:
003⫶ # existing keys
004⫶ content_categories:
005⫶ parent_location_remote_id: <content_categories_remote_id>
006⫶ content_type: content_category
007⫶ field_mappings:
008⫶ identifier: category_identifier
009⫶ parent: parent_category
010⫶                name: name_field
010⫶                name: name
011⫶            assigned_content_tab: false

docs/content_management/taxonomy/taxonomy.md@75:``` yaml
docs/content_management/taxonomy/taxonomy.md@76:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 0, 2) =]] # existing keys
docs/content_management/taxonomy/taxonomy.md@77:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 9, 10) =]] # existing keys
docs/content_management/taxonomy/taxonomy.md@78:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 17, 18) =]]
docs/content_management/taxonomy/taxonomy.md@79:```

001⫶ibexa_taxonomy:
002⫶ taxonomies:
003⫶ # existing keys
004⫶ content_categories:
005⫶ # existing keys
006⫶ register_main_menu: false

011⫶            assigned_content_tab: false

docs/content_management/taxonomy/taxonomy.md@75:``` yaml
docs/content_management/taxonomy/taxonomy.md@76:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 0, 2) =]] # existing keys
docs/content_management/taxonomy/taxonomy.md@77:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 9, 10) =]] # existing keys
docs/content_management/taxonomy/taxonomy.md@78:[[= include_file('code_samples/taxonomy/config/packages/ibexa_taxonomy.yaml', 17, 18) =]]
docs/content_management/taxonomy/taxonomy.md@79:```

001⫶ibexa_taxonomy:
002⫶ taxonomies:
003⫶ # existing keys
004⫶ content_categories:
005⫶ # existing keys
006⫶ register_main_menu: false

Download colorized diff

github-actions[bot] avatar May 06 '25 12:05 github-actions[bot]