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 data flow docs to be accurate, even if not complete. #8194

Merged
merged 1 commit into from Jul 27, 2021

Conversation

rtibbles
Copy link
Member

@rtibbles rtibbles commented Jul 8, 2021

Summary

  • While going over docs, realized that the current documentation has not been updated with some fairly major changes
  • This does those very simple changes, but omits larger rewrites.

Testing checklist

  • 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
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • 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

@rtibbles rtibbles added the TAG: developer docs Technical docs and code comments label Jul 8, 2021
@rtibbles
Copy link
Member Author

Self merging, we can iterate more in future.

@rtibbles rtibbles merged commit 7999928 into learningequality:develop Jul 27, 2021
@rtibbles rtibbles deleted the document_this branch July 27, 2021 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
TAG: developer docs Technical docs and code comments
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant