search

typedb / typedb-docs

TypeDB Documentation
27 stars 72 forks source link

Avoid name conflicts by using unique names for downloadable .tql files #570

Open alexjpwalker opened 3 years ago

alexjpwalker commented 3 years ago

This issue was migrated from https://github.com/vaticle/typedb-studio/issues/260

Problem to Solve

In the https://dev.grakn.ai/docs/general/quickstart doc, schema.gql is too generic, call it friendship-schema.gql, or something more descriptive - maybe grakn-friendship-schema.gpl! They will be downloading more such schemas in the future, from your site and elsewhere, let them not be lost in their download folder.

Question: Feel free to study the content of social-network-schema.gql. <=== which schema is this talking about, please fix this if its a typo?

Current Workaround

Keep track of the .gql files downloaded.

Proposed Solution

Give relevant graql download files representative names.

Additional Information

On the back of the slack channel discussions

izmalk commented 1 year ago

[`social-network-schema.tql`](../files/social-network/schema.tql){: target="_blank" download="social-network-schema.tql"} This solution works fine. I should implement it throughout the docs whenever a single schema file is downloaded.