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

Update README information around toggles usage in Simorgh #7456

Open
1 task
tochwill opened this issue Aug 10, 2020 · 1 comment
Open
1 task

Update README information around toggles usage in Simorgh #7456

tochwill opened this issue Aug 10, 2020 · 1 comment
Labels
Documentation Refinement Needed This is ready for refinement. It shouldn't be worked on until it has been refined by Dev & Test. technical-work Technical debt, support work and building new technical tools and features

Comments

@tochwill
Copy link
Contributor

tochwill commented Aug 10, 2020

Is your feature request related to a problem? Please describe.

  • We need to update the README in useToggles as it's outdated and says toggles aren't service specific, they now can be in iSite.
  • We should add an explanation of how remote toggles and default toggles work in the README that exists alongside the toggles config. This should explain how and where the data is fetched and merged, and the function of the default toggles.
  • localToggles in src/app/lib/utilities/getToggles/index.js should be renamed to defaultToggles (or similar) for clarity.

Describe the solution you'd like
Make the required README updates to improve clarity over how Simorgh toggles work.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Testing notes
[Tester to complete]

Dev insight: Will Cypress tests be required or are unit tests sufficient? Will there be any potential regression? etc

  • This feature is expected to need manual testing.

Additional context
Add any other context or screenshots about the feature request here.

@tochwill tochwill added Refinement Needed This is ready for refinement. It shouldn't be worked on until it has been refined by Dev & Test. ws-home ads cross-team For visibility for both World Service teams (Engage & Media) labels Aug 10, 2020
@joshcoventry joshcoventry added ws-articles Tasks for the WS Articles Team and removed ws-home labels Sep 18, 2020
@joshcoventry joshcoventry added Documentation and removed ws-articles Tasks for the WS Articles Team ads labels Oct 16, 2020
@joshcoventry joshcoventry removed the cross-team For visibility for both World Service teams (Engage & Media) label Aug 12, 2021
@andrewscfc andrewscfc added the technical-work Technical debt, support work and building new technical tools and features label Jan 18, 2022
@andrewscfc
Copy link
Contributor

Readme is still wrong and needs updating: https://github.com/bbc/simorgh/blob/latest/src/app/hooks/useToggle/README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Refinement Needed This is ready for refinement. It shouldn't be worked on until it has been refined by Dev & Test. technical-work Technical debt, support work and building new technical tools and features
Projects
None yet
Development

No branches or pull requests

3 participants