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

Improve submodule command info in the docs site #45

Open
7 tasks
jbeveland27 opened this issue May 8, 2020 · 0 comments
Open
7 tasks

Improve submodule command info in the docs site #45

jbeveland27 opened this issue May 8, 2020 · 0 comments

Comments

@jbeveland27
Copy link
Contributor

Some things to possibly add to documentation based on experiences with PRs so far.

  • Add example commands for adding and updating submodule to the add-checklist and update-checklist pages. They're present in the process outline on the home page, but might be helpful to have them quickly reference-able if contributors skip directly to the Add Nerdpack/Update Nerdpack page.
  • Add submodule section to Reference Docs
    • Possibly detail how to update submodule in the same PR to avoid contributors feeling like they need to close and open a new PR when changes are requested
  • Add detail that submodules URLs should be HTTPS rather than SSH on the Add Nerdpack checklist and Reference Docs
  • (Possibly) Add detail about automation to Reference Docs
    • Detail checks for the PR, including how it also runs when a PR is updated with new commits
    • Deploy process
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

No branches or pull requests

1 participant