Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

docs: Clean up documentation.#1025

Merged
dianakhuang merged 1 commit intomasterfrom
diana/docs-cleanup
Feb 22, 2023
Merged

docs: Clean up documentation.#1025
dianakhuang merged 1 commit intomasterfrom
diana/docs-cleanup

Conversation

@dianakhuang
Copy link
Copy Markdown
Contributor

  • Removed out of date known issues.
  • Cleaned up workflow commands.
  • Removed references to out of date Pycharm instructions.

I've completed each of the following or determined they are not applicable:

  • Made a plan to communicate any major developer interface changes (or N/A)

Copy link
Copy Markdown
Contributor

@rgraber rgraber left a comment

Choose a reason for hiding this comment

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

Why are we replacing the lms-* commands with dev.*.lms ? I usually use lms-*

@dianakhuang
Copy link
Copy Markdown
Contributor Author

Mostly this is the better-supported convention? But I don't have strong feelings about it and can go either way.

@rgraber
Copy link
Copy Markdown
Contributor

rgraber commented Feb 22, 2023

Mostly this is the better-supported convention? But I don't have strong feelings about it and can go either way.

Actually this also brings up a question for me about why we have both and if that's more confusing than helpful. But I guess it makes sense to use dev.action.service since that's how it's described in the makefile.

@dianakhuang
Copy link
Copy Markdown
Contributor Author

I'm not sure why we introduced a new one, but I feel like the lms- commands were kept around for backwards compatibility.

Copy link
Copy Markdown
Contributor

@rgraber rgraber left a comment

Choose a reason for hiding this comment

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

I know we're looking for quick wins, so approving, but in the future it might be useful to have examples of what kinds of changes require a full restart

@rgraber
Copy link
Copy Markdown
Contributor

rgraber commented Feb 22, 2023

I know we're looking for quick wins, so approving, but in the future it might be useful to have examples of what kinds of changes require a full restart

Somehow I completely skipped over the examples that were already there. Made a request to add a line about how runserver occasionally just stops picking up changes because it doesn't feel like it.

- Removed out of date known issues.
- Cleaned up workflow commands.
- Removed references to out of date Pycharm instructions.
@dianakhuang dianakhuang merged commit 1a84875 into master Feb 22, 2023
@dianakhuang dianakhuang deleted the diana/docs-cleanup branch February 22, 2023 17:59
nsprenkle pushed a commit that referenced this pull request Nov 21, 2023
- Removed out of date known issues.
- Cleaned up workflow commands.
- Removed references to out of date Pycharm instructions.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants