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

Rule Collection – Improving the Schema #1539

Merged
merged 6 commits into from
Oct 8, 2024

Conversation

isaaclombardssw
Copy link
Member

@isaaclombardssw isaaclombardssw commented Oct 8, 2024

Added descriptions, and auto-population for new rules fields (filename, date created and also guid).

πŸ€–πŸ€–πŸ€–

This pull request includes several enhancements to the Rules collection in the tina/collections/rules.ts file, focusing on adding descriptions and improving the user interface for various fields.

Enhancements to the Rules collection:

  • Added a defaultItem function to generate default values for new rules, including a GUID, creation date, and filename. (tina/collections/rules.ts)
  • Added descriptions to multiple fields to provide better context and guidance for users:
    • title field: "This is used as the major heading for the rule." (tina/collections/rules.ts)
    • uri field: "The URI of the rule – this defines the slug and references." (tina/collections/rules.ts)
    • authors field: "The list of contributors for this rule." (tina/collections/rules.ts)
    • related field: "The URIs of rules that should be suggested based on the content of this rule." (tina/collections/rules.ts)
    • created field: "If you see this field, contact a dev immediately 😳 (should be a hidden field generated in the background)." (tina/collections/rules.ts)
    • archivedreason field: "If this rule has been archived, summarise why here." (tina/collections/rules.ts)
    • guid field: "If you see this field, contact a dev immediately 😳 (should be a hidden field generated in the background)." (tina/collections/rules.ts)
    • seoDescription field: "A summary of the page content, used for SEO purposes. This can be generated automatically with AI." (tina/collections/rules.ts)
    • body field: "Rule content. This is where the magic happens." (tina/collections/rules.ts)
  • Improved the UI for the authors field by adding item properties to display the contributor's name with an icon. (tina/collections/rules.ts)
  • Made the created and guid fields hidden in the UI to avoid user modification. (tina/collections/rules.ts)

πŸ€–πŸ€–πŸ€–

Relates to #1464.

tina/collections/rules.ts Show resolved Hide resolved
tina/collections/rules.ts Outdated Show resolved Hide resolved
bradystroud
bradystroud previously approved these changes Oct 8, 2024
@isaaclombardssw isaaclombardssw merged commit 4fcb7e5 into tina/main Oct 8, 2024
@isaaclombardssw isaaclombardssw deleted the rule-collection branch October 8, 2024 22:06
tkapa added a commit that referenced this pull request Oct 15, 2024
* Run TinaCMS/CLI Init

* Add TinaCMS_Gatsby workaround Docs.

* TinaCMS Admin panel showing

* Delete local content folder

* Set up Separate Repo Content

* Update Gatsby config

* Add Rules collection

* Update Config

* Remove Posts collection

* Keep /content

* Update Env var

* Update value

* Update build command

* Remove Local content path if not defined

* Update template-build

* Update Client and Token

* Update Env file name

* Use tina sample for now

* Force branch to tina/sample-content

* Update to make 2 different .env files

* Fix GA Missing

* Remove unknown variable

* Fix deployment Storage Account Name

* Update roleAssignment name with storage account

* Add /rules base build path :(

* Update base path

* Update with basic TinaCMS F5 experience

* πŸ“„ Update Definition of Done for TinaCMS Migration (#1520)

Update Definition of Done

* Tina/fix built admin (#1527)

* Admin Path available

* Update template-build

* Remove cache for Tina Migration only (#1530)

Remove cache

* ✨ TinaCMS | Configure Base Path - /admin (#1531)

* Update tina base path

* Add Configurable Tina base path

* ♻️ Use .env for TinaCMS Branch (#1532)

* Update to use .env content branch

* Update .env template

* ♻️ Update Env Var names to be Consistent (#1537)

* Make variable naming consistent

* Use TINA_ instead

* ✨ TinaMarkdown - Using it on the Rule template and category pages (#1538)

* added greybox match to tina schema

* got markdown reading from rules

* πŸ”₯ Removed commented code

* Added more matches

* added tildes to bodySchema

* got markdown rendering

* refactored markdown parsing functions into a separate file

* removed commented code

* got tinamarkdown working for rule list by category

* re-added import for MD

* re-added greybox components

* Re-added htmlAst to graphql and greybox import

* removed console logs

* Removed unused regex code

---------

Co-authored-by: Calinator444 <caleb.williams5247@gmail.com>

* πŸ’Έ πŸ”₯  Refactoring the Tina Markdown PR Content - Removing old code and comments (#1540)

* removing old code and comments

* trying to turn off type checking lint

* removing a comment

* Rule Collection – Improving the Schema (#1539)

* updating the rules schema

* merge with main fixes

* comments and description fixes

* linking to a PBI in description

* πŸ—’οΈ Tina Parser - Remove unindented lists (#1551)

πŸ”₯ Removed helper method for unindented lists

Co-authored-by: Calinator444 <caleb.williams5247@gmail.com>

* πŸ¦™ TinaCMS - Add Sidebar collection (#1554)

* Add Single Document Sidebar collection

* Add Todo to implement sidebar collection

* Update tina lock

* Add Images to Blocks

* Migrate blocks into components. Mark Todos for later

---------

Co-authored-by: Caleb Williams [SSW] <65635198+Calinator444@users.noreply.github.com>
Co-authored-by: Calinator444 <caleb.williams5247@gmail.com>
Co-authored-by: Isaac Lombard [SSW] <152236421+isaaclombardssw@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants