Skip to content

Updates to studio documentation#3561

Merged
AllanOXDi merged 1 commit intolearningequality:unstablefrom
bjester:doc-updates2
Aug 23, 2022
Merged

Updates to studio documentation#3561
AllanOXDi merged 1 commit intolearningequality:unstablefrom
bjester:doc-updates2

Conversation

@bjester
Copy link
Copy Markdown
Member

@bjester bjester commented Aug 22, 2022

Summary

Description of the change(s) you made

  • updates documentation for using pyenv
  • recommends using volta and removes mentions of nodeenv
  • cleans up documentation related to running tests
  • adds new make run-services recipe that runs both celery and docker services
  • cleans up Makefile, removing unused commands
  • cleans up yarn scripts, removing and renaming commands

References

https://learningequality.slack.com/archives/C0LK8QS9J/p1660677002490889

Comments

There appeared to be some legacy Makefile recipes that are no longer required with new i18n translation handling, which this PR removes.


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

Copy link
Copy Markdown
Member

@AllanOXDi AllanOXDi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@AllanOXDi AllanOXDi merged commit bcc3e8e into learningequality:unstable Aug 23, 2022
Copy link
Copy Markdown
Member

@LianaHarris360 LianaHarris360 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran the code locally and everything worked fine on my end. The documentation and testing updates were super helpful!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants