KinsonDigital / VelaptorDocs

https://docs.velaptor.io
GNU Free Documentation License v1.3
6 stars 6 forks source link

⚙️Remove config comments from config files #309

Open CalvinWilkinson opened 1 week ago

CalvinWilkinson commented 1 week ago

Complete The Item Below

Description

Remove various config comments from the following files:

Reason: This is because these comments were special comments used by custom scripting to enable and disable these config values. These were used in the site's early days, but the scripts and their use have been removed. They are not required anymore.

docusaurus.config.ts comment removal (1):

- // ⚠️DO NOT CHANGE THIS⚠️
- // This is used as part of the manual testing process for the CICD side of the project.
- // <flag id=api enabled=true>
{
    type: 'doc',
    docId: 'api/Namespaces',
    position: 'left',
    label: 'API',
},

docusaurus.config.ts comment removal (2):

{
    href: 'https://discord.gg/qewu6fNgv7',
    position: 'right',
    className: "header-discord-link"
},
- // ⚠️DO NOT CHANGE THIS⚠️
- // This is used as part of the manual testing process for the CICD side of the project.
- // <flag id=testing enabled=false>
- // {
- // type: 'doc',
- // label: 'API Testing',
- // position: 'left',
- // docId: 'api/Namespaces',
- // },
- // </flag>

sidebars.ts comment removal (2):

- // ⚠️DO NOT CHANGE THIS⚠️
- // This is used as part of the manual testing process for the CICD side of the project.
- // <flag id=api enabled=true>
api: [{type: 'autogenerated', dirName: 'api'}],
- // </flag>

Acceptance Criteria

- [ ] The comments in the _**docusaurus.config.ts**_ have been removed
- [ ] The comments in the _**sidebars.ts**_ have been removed

ToDo items

- [x] Change type labels added to this issue.  Refer to the _**Change Type Labels**_ section below.
- [x] A priority label was added to this issue.  Refer to the _**Priority Type Labels**_ section below.

Additional Information:

Change Type Labels

|--------------|---------------------------------------------------------------------------------------------------| | CICD | https://github.com/KinsonDigital/VelaptorDocs/labels/cicd | | Dependency Update | https://github.com/KinsonDigital/VelaptorDocs/labels/%F0%9F%93%A6dependency-update | | Miscellaneous | https://github.com/KinsonDigital/VelaptorDocs/labels/miscellaneous | | Guide Doc Changes | https://github.com/KinsonDigital/VelaptorDocs/labels/%F0%9F%93%9Cguide-doc-changes |

Priority Type Labels

Priority Type Label
Low Priority https://github.com/KinsonDigital/VelaptorDocs/labels/low-priority
Medium Priority https://github.com/KinsonDigital/VelaptorDocs/labels/medium-priority
High Priority https://github.com/KinsonDigital/VelaptorDocs/labels/high-priority

Code of Conduct

LeaDevelop commented 1 week ago

I can take this one, if no one is on it :)