typedb/typedb-docs

Update the new "Basics" page structure/content

Closed this issue · 2 comments

Description

Reorder the page as follows:

  • Clients (bring over from old Client/Overview page)
  • Databases
  • Sessions (add explanation of schema vs. data sessions)

Where we have "Best Practices", let's create TIP admonitions (similar to NOTE/WARNING)
Add TypeQL, Java, Node.js, Python examples (e.g., create database, connect client, establish session)
And let's rename this page Connections

Location of Content

/docs/typedb/dev/basics

Expected Content

NA

Actual Content

NA

Additional information

NA

Clients (bring over from old Client/Overview page)
Databases
Sessions (add explanation of schema vs. data sessions)

  1. We already have a page called Clients. The renaming of the connection would add to user confusion. Also I agree connection might be not the best term here. But I felt it might be important to use this exact word (as in How do I connect to your DB) as a title and provide some overview. If you want I can add some more content here and even add an illustration.
  2. The exact use order is: Client (we select server addr) -> Session (we select DB name and session type) -> Transaction -> Database.
    Which can be seen in code as:
with TypeDB.core_client("localhost:1729") as client:
        with client.session(config.db, SessionType.DATA) as session:
            with session.transaction(TransactionType.READ, TB) as transaction:
                typeql_read_query = "match $g isa genre-tag;

I'm not sure why would we need Database content before Session. We don't need anything from Database except its name at this stage.
Transaction is so important we gave it a separate page. We can do the same with the Database if you want.

P.S. BTW I believe Client handles a network connection to the server while Session handles a more high-level connection to a Database.

Where we have "Best Practices", let's create TIP admonitions (similar to NOTE/WARNING)
Add TypeQL, Java, Node.js, Python examples (e.g., create database, connect client, establish session)
And let's rename this page Connections

I'm afraid it is not technically possible right now. We are somewhat limited to the following variants:

  • important
  • note
  • warning
  • advanced

We can probably add a new one but I'm not sure that's a good idea until we migrate on a new docs engine.

Just to clarify - do you mean the Note within the Connection section or the section inside the Sessions?
And lastly — I can do one of the above (maybe Note will be most suitable) and add bold TIP: at the beginning as a temporary solution.