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 published field to ProgrammingEnvironment #45110

Merged

Conversation

bethanyaconnor
Copy link
Contributor

@bethanyaconnor bethanyaconnor commented Mar 1, 2022

Step 1 of 2 to add the ability to hide and unhide documentation. This feature will allow curriculum writers to add a new programming environment and write the documentation without it being immediately accessible to students. This will be useful as we move Javalab documentation to levelbuilder and will allow us to decouple that process from launching code docs on code studio.

PRs:

  1. (This PR) Add a published column to programming_environments
  2. (Allow publishing/unpublishing programming environments #45113) Allow editing of published and use it to determine access rules for code docs

PR Checklist:

  • Tests provide adequate coverage
  • Privacy and Security impacts have been assessed
  • Code is well-commented
  • New features are translatable or updates will not break translations
  • Relevant documentation has been added or updated
  • User impact is well-understood and desirable
  • Pull Request is labeled appropriately
  • Follow-up work items (including potential tech debt) are tracked and linked

@bethanyaconnor bethanyaconnor marked this pull request as ready for review March 2, 2022 18:38
@bethanyaconnor bethanyaconnor requested a review from a team as a code owner March 2, 2022 18:38
@bethanyaconnor bethanyaconnor requested a review from a team March 2, 2022 18:38
Copy link
Contributor

@maureensturgeon maureensturgeon left a comment

Choose a reason for hiding this comment

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

PR comment says "Add a published column to programming_expressions" but then the PR is for programming environments, it should be programming environments, right?

Also for my learning, could you explain what the programming_environments table represents?

@bethanyaconnor
Copy link
Contributor Author

PR comment says "Add a published column to programming_expressions" but then the PR is for programming environments, it should be programming environments, right?

🤦‍♀️ thank you -- fixed! I get these mixed up constantly haha

Also for my learning, could you explain what the programming_environments table represents?

They are essentially the IDEs that have code docs (IDE is the old name). So, right now, there's only 4: gamelab, spritelab, weblab, and applab, with javalab being added in the coming weeks. We don't have documentation for our other labs, though they could theoretically be added in the future

@maureensturgeon
Copy link
Contributor

PR comment says "Add a published column to programming_expressions" but then the PR is for programming environments, it should be programming environments, right?

🤦‍♀️ thank you -- fixed! I get these mixed up constantly haha

Also for my learning, could you explain what the programming_environments table represents?

They are essentially the IDEs that have code docs (IDE is the old name). So, right now, there's only 4: gamelab, spritelab, weblab, and applab, with javalab being added in the coming weeks. We don't have documentation for our other labs, though they could theoretically be added in the future

Ok sorry, one more question, so what would it mean for spritelab to be "unpublished" because students will still be able to access spritelab, right?

@bethanyaconnor
Copy link
Contributor Author

so what would it mean for spritelab to be "unpublished" because students will still be able to access spritelab, right?

Good question! For better and worse, ProgrammingEnvironment is separate from the labs themselves, apart from a general convention to have their names be the same. So if spritelab was "unpublished", studio.code.org/p/spritelab would still be accessible and students could still make projects, but studio.code.org/programming_environments/spritelab would not be accessible, and, most importantly tbh, it would not appear as a link on studio.code.org/programming_environments.

I'm definitely open to a different name here if there's a way to make this clearer!

Copy link
Contributor

@maureensturgeon maureensturgeon left a comment

Choose a reason for hiding this comment

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

Thanks for answering all of my questions!

@bethanyaconnor bethanyaconnor merged commit d7b898b into staging Mar 3, 2022
@bethanyaconnor bethanyaconnor deleted the add-published-to-programming-environment-migration branch March 3, 2022 16:34
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.

None yet

2 participants