Giter Club home page Giter Club logo

cloud-docs's Introduction

cloud-docs's People

Contributors

amotl avatar infoverload avatar kojinkai avatar marijaselakovic avatar matkuliak avatar matthijskrul avatar msbt avatar nomicode avatar proddata avatar sstorm avatar taliik avatar walbeh avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

marijaselakovic

cloud-docs's Issues

Select and/or adjust canonical toctree

About

  • crate-docs-theme==0.29.0 has been released, including the updates to the primary navigation coming from crate/crate-docs-theme#391.
  • The reworked CrateDB Cloud Docs project already has it, see https://crate.io/docs/cloud/. Other projects will need to be rebuilt.
  • Navigation seems to work well, or will work well, when all pages have been refreshed in Fastly's cache.

Details

On the preview page, and in this screenshot, you will see both toctree variants currently defined at cloud-docs:/docs/index.md.

image

The bottom section reflects the previous physical structure "Reference vs. Tutorials vs. How-To Guides", and the top section is made of a handcrafted toctree, which is reflecting the same structure and the order of the items from the "Manage" section of that page, directly referencing corresponding sections of the documentation, no matter where they are located.

Q&A

On this matter, I am asking which variant you would prefer? I think the handcrafted version has a point, while the other one, based on the previous physical structure, will be dissolved anyway in the course of the next iterations? Let me know if you have a different opinion, or other suggestions about this layout/design/structure/UX detail.

/cc @kojinkai, @SStorm, @matkuliak, @msbt

Blog Post: How to tweak and tune a CrateDB Cluster

Who

A CrateDB user

What

Learn about best practices on how to optimize their CrateDB Cluster

Why

To now which best practices to apply for which scenarios


ACs

  • A blogpost about 3-5 performance tuning best practices is available as a draft
  • How to setup the best practises is explained step-by-step
  • Pros/Cons and implications are described for each best practice
  • Blogpost is reviewed with important stakeholders (CrateDB, CE)
  • Blogpost is published

Improve guidance and structure on Sign Up, Free Trial, Deploy pages

About

Now, after getting the repository reasonably into shape, the next steps are about sanding it properly.

@proddata already offered two valuable suggestions where to improve right away.

  • I can imagine all the (Sign Up, Free Trial, Deploy) sections on two pages. We don’t need to explain every step of how to create a user account.
  • Regarding the payment options, it really just is a single payment method currently. It was a bit different in the past.

Images using scale are stretched

Documentation feedback

The images on this page that have :scale: 50% via https://github.com/crate/cloud-docs/blob/main/docs/tutorials/edge/introduction.rst?plain=1#L310-L312 (and probably all others that use this) are skewed/stretched. I thought that bug was fixed, but apparently it's not. There's a card on the website board which describes possible solutions, please ping me if/when you have bandwidth for that @amotl @matkuliak


Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.