Skip to content

Implement new tag format to be compatible with the WJ App #2

@EzioTheDeadPoet

Description

@EzioTheDeadPoet

A new "2.0" Tag format that contains more metadata useful for WJ to autodetect and promt users with common fixes based on the issues found in their logs.

Uses github actions in the tags repo to generate a website rendering of the tags for users to read.

Maybe implement code to only redirect to the website if the tag is too long and contains an image (image requirement maybe needs to be added to the metadata).

Copying notes about that potential new format from discord here:


How to add a tag

To add a new tag simply make a pull request to this repository editing the tags.yaml file by adding a new tag like in the code-block below:

tag_sections:
  - name: 'Tutorial Tags' # Category/Chapter of Tags the tag is part of. Don't make a new one if a ma
    tags:
      - name: tag_name # must not contain special characters or whitespace characters with the exception of '_'
        summary: "this is an example tag" # This summary will be shown in the overview and in the bot embed that links to the fully rendered response page.
        content: 'tags/permanent/general/tag_name.md'
        triggers: ["Example Trigger", "Different Valid Example Trigger"] # List of log triggers for the tag bot to respond to with this tag.
      other_tag:
        # ... other_tag info
      # ... more tags
  # ... more sections

So the added tag in this case would be:

- name: tag_name # must not contain special characters or whitespace characters with the exception of '_'
  summary: "this is an example tag" # This summary will be shown in the overview and in the bot embed that links to the fully rendered response page.
  content: 'tags/permanent/general/tag_name.md'
  triggers: ["Example Trigger", "Different Valid Example Trigger"] # List of log triggers for the tag bot to respond to with this tag.

To add an alias for a tag you add a new tag that needs to look like the following:

- name: alias_tag # Alias command
  source_tag: tag_name # Command for the tag that should be triggered.

to avoid cases of double defined tags just because someone prefers or remembers an older command better 🤣


Metadata

Metadata

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions