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

Troubleshooting section major update #705

Open
wants to merge 3 commits into
base: development
Choose a base branch
from

Conversation

izmalk
Copy link
Contributor

@izmalk izmalk commented Aug 17, 2023

What is the goal of this PR?

Add content for a Troubleshooting section.

What are the changes implemented in this PR?

Renamed, restructured, and added the content to the Troubleshooting.

@izmalk izmalk self-assigned this Aug 17, 2023
@typedb-bot
Copy link
Member

typedb-bot commented Aug 17, 2023

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.


Trivial Change

  • This change is trivial and does not require a code or architecture review.

Code

  • Packages, classes, and methods have a single domain of responsibility.
  • Packages, classes, and methods are grouped into cohesive and consistent domain model.
  • The code is canonical and the minimum required to achieve the goal.
  • Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
  • Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
  • The code is algorithmically efficient and scalable for the whole application.

Architecture

  • Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
  • Any required build and release automations are updated and/or implemented.
  • Any new components follows a consistent style with respect to the pre-existing codebase.
  • The architecture intuitively reflects the application domain, and is easy to understand.
  • The architecture has a well-defined hierarchy of encapsulated components.
  • The architecture is extensible and scalable.

@benjaminasmall
Copy link
Contributor

I think a lot of this could use a rewrite, but I've done a bit for now.

typedb-src/modules/ROOT/pages/development/best.adoc Outdated Show resolved Hide resolved
typedb-src/modules/ROOT/pages/development/best.adoc Outdated Show resolved Hide resolved
typedb-src/modules/ROOT/pages/development/best.adoc Outdated Show resolved Hide resolved
typedb-src/modules/ROOT/pages/development/best.adoc Outdated Show resolved Hide resolved
typedb-src/modules/ROOT/pages/development/best.adoc Outdated Show resolved Hide resolved
typedb-src/modules/ROOT/pages/development/best.adoc Outdated Show resolved Hide resolved
@izmalk izmalk removed their assignment Aug 29, 2024
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.

3 participants