aiven / devportal Goto Github PK
View Code? Open in Web Editor NEWResources for users of the projects on the Aiven platform
Home Page: https://docs.aiven.io
License: Creative Commons Attribution 4.0 International
Resources for users of the projects on the Aiven platform
Home Page: https://docs.aiven.io
License: Creative Commons Attribution 4.0 International
Detail how to find and use the connection details for this service
Add the initial product page, following existing template/conventions.
Create a getting started guide for the product
Add initial product content following existing templates/conventions
The starting point for this is the sphinx-ready exported content in #15 The page title from that data set are used in the issues/PRs below, with the PR that already made use of the content indicated where it's been migrated (this will help with redirects later)
Create a getting started guide for the product
Add Connection details to PG from Go
Add initial product content following existing templates/conventions
Create a getting started guide for the product
Detail how to find and use the connection details for this service
The *nix Makefile supports use of command line Vale with make spell
.
Add the same functionality to make.bat
for our Windows users, and add (or link) Windows installation instructions including how to add the executable to the path, for Vale.
Let's inform users why they might like to replicate, how to set up replicas, and everything else they need to know. Split the PR if it ends up bigger than 3 articles though!
Candidate content from the previous docs site:
Create a getting started guide for the product
Add initial product content following existing templates/conventions
Create a page, similar to the M3 one, showing how to create a PG instance
Ensure that new content uses sentence case for titles by adding a vale configuration
Let's flesh out this page a bit, a lot of users will come through here. My suggestions:
psql
example on this page, so that people can immediately find itConnect to PG with the PgAdmin4
Hi there, can we please add the Aiven favicon to the browser tab for dev portal?
Detail how to find and use the connection details for this service
We started out with title case, and now have a mix. Please check titles and ensure continuity
Create a getting started guide for the product
What's an upgrade and how do you do it on Aiven?
Possible source content:
Hi there!
sphinxcontrib-mermaid is currently broken for Sphinx >= 4.0, here is the PR fixing it.
For now, trying to run make livehtml
returns the following error:
Extension error:
Could not import extension sphinxcontrib.mermaid (exception: cannot import name 'ENOENT' from 'sphinx.util.osutil' (/Users/jonatasbaldin/aiven/devportal/venv/lib/python3.8/site-packages/sphinx/util/osutil.py))
Command exited with exit code: 2
The server will continue serving the build folder, but the contents being served are no longer in sync with the documentation sources. Please fix the cause of the error above or press Ctrl+C to stop the server.
And I got 404
on the index page on the live server,
Disabling out the sphinxcontrib.mermaid
from conf.py:extensions
fixes the issue temporarily.
We have a couple of options:
What do you think?
Detail how to find and use the connection details for this service
Create a getting started guide for the product
Detail how to find and use the connection details for this service
How can a user integrate Grafana with Postgres to visualise their data? We also have a built-in dashboard available.
Possible source content to use as a starting point:
Add initial product content following existing templates/conventions
A couple of howTos about migration including
Adding the concept of connection pooling from https://help.aiven.io/en/articles/964730-postgresql-connection-pooling
Connect to PG with psql
Let's explain how users can work with backups
Possible content to include/use as a basis:
Detail how to find and use the connection details for this service
Add initial product content following existing templates/conventions
The old official product names ("Aiven Kafka" etc) were changed to the new ("Aiven for Apache Kafka") sometime in 2020. When transferring (or editing) content, check that product names follow the new format and the conventions as specified here: https://docs.google.com/document/d/1PklbdRuxSUycQ2vtSkYfdZZY7MokdR-sGkQYcZnzr-E/edit?usp=sharing
NOTE: M3 is the only product new enough to only have a new format name.
You can't be root on a hosted service, so how do you perform those more DBA-type tasks? What's different about Aiven PostgreSQL for this sort of thing?
Candidate content from the export:
Add initial product content following existing templates/conventions
Adding page about connection limits
We don't have (or I couldn't find) documentation related to all supported "Advanced Configuration" parameters.
We support a huge part of the postgresql.conf, but we might not support all of them (or have different ones).
Would be nice to have a page/table with:
Create a getting started guide for the product
We need to collect feedback from users on whether they found the content helpful or not. This should be in the form of a 👍 and 👎 button pair, and an optional comment. Users need to understand that we can't identify them on devportal so they need to contact support if they need a response (or open a GitHub issue).
Each data point should have:
Implementation details are open for discussion but my suggestion:
A follow-on issue will be needed for reporting on the collected data - create it as the final step in this task once we know how this issue chose to store data.
Detail how to find and use the connection details for this service
The API docs currently live somewhere else but could they come here to be part of the site?
Add initial product content following existing templates/conventions
Create a getting started guide for the product
How to connect with python similar to M3 one
Add initial product content following existing templates/conventions
Create a getting started guide for the product
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.