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

Add Manual Annotations to Dynamic Content #18

Merged
merged 16 commits into from
Dec 8, 2024

Conversation

UlisesGascon
Copy link
Member

@UlisesGascon UlisesGascon commented Dec 8, 2024

Main Changes

This PR introduces the ability to combine dynamic content with manual annotations in the details (09d66e1) and implementations (8f37303) files.

Dynamic content is managed by the @ulisesgascon/text-tags-manager package, a core dependency of this project (016063b). Tags within these files are automatically updated or inserted whenever a new detail or implementation is added (49ba99c).

For example, the githubOrgMFA implementation has been updated to include manual annotations (revert b216d3c), restoring annotations that were previously removed (8460de4).

To support this change, the documentation has been updated (cc83c54) with clear instructions on working with dynamic content and tags. The updated section is as follows:

Improve the content via PR(s)

If you want to enhance any page, you can do so as you would in any other project (via a Pull Request, example). However, please note certain rules, as some parts of the files are dynamically generated, and your changes could be overwritten.

Rules

  1. Metadata is added automatically. Manual additions or modifications to metadata are not allowed.
  2. You can contribute any content to any file, but avoid making changes within the sections enclosed by specific tags, as these sections are dynamically >generated. For example:
    OK
    <!-- DESCRIPTION:START -->
    AVOID (AUTOMATED)
    <!-- DESCRIPTION:END -->
    OK
    

Changelog

@UlisesGascon UlisesGascon added this to the Use dashboard database milestone Dec 8, 2024
@UlisesGascon UlisesGascon self-assigned this Dec 8, 2024
Copy link

netlify bot commented Dec 8, 2024

Deploy Preview for openjs-security-program-standards ready!

Name Link
🔨 Latest commit cc83c54
🔍 Latest deploy log https://app.netlify.com/sites/openjs-security-program-standards/deploys/67550d1586b6430008cf8d0d
😎 Deploy Preview https://deploy-preview-18--openjs-security-program-standards.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@UlisesGascon UlisesGascon changed the title Add support tags in details Add support tags in details and implementations Dec 8, 2024
@UlisesGascon UlisesGascon changed the title Add support tags in details and implementations Add Manual Annotations to Dynamic Content Dec 8, 2024
@UlisesGascon UlisesGascon marked this pull request as ready for review December 8, 2024 03:16
@UlisesGascon UlisesGascon merged commit d0e2711 into main Dec 8, 2024
5 checks passed
@UlisesGascon UlisesGascon deleted the feat/add-support-for-tags branch December 8, 2024 03:17
@UlisesGascon UlisesGascon mentioned this pull request Dec 8, 2024
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.

1 participant