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 development, troubleshooting, and process documentation #12022

Closed
wkurniawan07 opened this issue Jan 14, 2023 · 0 comments · Fixed by #12358
Closed

Update development, troubleshooting, and process documentation #12022

wkurniawan07 opened this issue Jan 14, 2023 · 0 comments · Fixed by #12358
Assignees
Labels
a-Docs User or developer docs

Comments

@wkurniawan07
Copy link
Member

wkurniawan07 commented Jan 14, 2023

  • Our troubleshooting guide / FAQs (https://teammates.github.io/teammates/troubleshooting-guide.html) has not been updated for very long now. Many frequent help requests should be documented, such as (but not limited to) server stuck at 85%, localhost:8080 returns 404/403, api-output is missing, front-end compilation error after pulling master branch.
  • Our setup is actually compatible with Java 17 now, but we're not yet ready to make the move. Nevertheless, we should not require any devs with only Java 17 to download Java 11 exclusively for TM, but with the caveat that the officially used language is still Java 11 and thus newer language features are not to be used.
    1. Install Java JDK 11.
  • We can adopt a newer version of Contributor Covenant instead of an older version 1.4 that we are currently using.
    • Although, admittedly, this is more of a formality than anything else.
  • We can add SECURITY.md to allow a more native integration for vulnerability reports.
  • With GitHub Discussions becoming the main communication channel, the previous way of using issue tracker is now discontinued. All related instructions need to be updated.

There are also more parts of the documentation referring to outdated practices; those need to be updated.

@wkurniawan07 wkurniawan07 added the a-Docs User or developer docs label Jan 14, 2023
@wkurniawan07 wkurniawan07 self-assigned this Apr 8, 2023
@wkurniawan07 wkurniawan07 changed the title Update troubleshooting guide + mention Java 17 compatibility Update development, troubleshooting, and process documentation Apr 8, 2023
wkurniawan07 added a commit that referenced this issue Apr 9, 2023
…cumentation (#12358)

* Add placeholder index.html

* Update troubleshooting guide

* Add preliminary JDK 17 support

* Update code of conduct to use latest version

* Add SECURITY.md

* Update RolesAndTechnologies to simple table

* Update workflow to sequence diagram

* Update outdated versions of design diagrams

* Fix outdated process descriptions

* Retire `t-*` label group

* Move help request from issue tracker to discussion forum
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-Docs User or developer docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant