docs: improve api docs (#5158)

* integrate docs into nav * generator for local use, production needs to be set by env * fix typo * local dev * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: add header params * rewrite docs links and improve ci * tweak build command * fix path * Update docs/docusaurus.config.js Co-authored-by: Max Peintner <max@caos.ch> * fix docker * docs: add header params * docs: Add tags to management api. add some descriptions * docs: more descriptions * docs: more descriptions * docs: required fields * docs: example request * docs: example request * docs: example request * docs: example request * docs: example request * docs: user metadata requests * docs: user requests * docs: user requests * docs: user requests * docs: user requests * docs: change nav add first methods to authentication api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: api sidenav * chore: use buf without docker * fix deploy * fix ci * fix vercel * docs: admin * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: security * docs: security * docs: admin api * docs: change to env vars * docs: auth api * docs: remove assets, deprecated requests, menu * reworked page with PaloAltoNetworks/docusaurus-openapi-docs * works with the resolutions * fix broken build by adding assets again * add tags to menu * chore: improve build speed * no-minify * test ssr * ssr 20 * use lazy * increase mem * use default mem * change names * docs: remove assets, deprecated requests, menu * docs: management api * docs: management api * docs: management api * docs: sidebar * not the best word smithing but it is ;-) * more typos * merge main * fix some error * trial * update grpc gateway * trigger vercel build * docs: deprecated requests * docs: deprecated requests --------- Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com> Co-authored-by: Max Peintner <max@caos.ch>
2025-08-11 21:27:42 +00:00 · 2023-02-23 12:08:06 +01:00
parent 50728129ee
commit aa9518ac02
68 changed files with 7570 additions and 23543 deletions
--- a/docs/nginx.conf
+++ b/docs/nginx.conf
@@ -0,0 +1,56 @@
+events { 
+  worker_connections  1024;  ## Default: 1024 
+} 
+ 
+http { 
+
+    include /etc/nginx/mime.types; 
+ 
+     server { 
+        
+        listen 8080;
+
+        location / { 
+          return 301 /docs;
+        } 
+ 
+        location /docs { 
+            root /usr/share/nginx/html;
+            index /docs/index.html;
+            try_files $uri $uri/ /docs/index.html?q=$query_string; 
+        } 
+
+        location = /docs/proxy/js/script.js {
+            proxy_pass https://plausible.io/js/script.js;
+            proxy_set_header Host plausible.io;
+            }
+
+        location = /docs/proxy/api/event {
+            proxy_pass https://plausible.io/api/event;
+            proxy_set_header Host plausible.io;
+            proxy_buffering on;
+            proxy_http_version 1.1;
+
+            proxy_set_header X-Forwarded-For   $proxy_add_x_forwarded_for;
+            proxy_set_header X-Forwarded-Proto $scheme;
+            proxy_set_header X-Forwarded-Host  $host;
+        }
+    } 
+ 
+    ## enable gzip compression 
+    gzip on; 
+    gzip_vary on; 
+    gzip_min_length 256; 
+    gzip_proxied any; 
+ 
+    gzip_types 
+      ## text/html is always compressed : https://nginx.org/en/docs/http/ngx_http_gzip_module.html 
+      text/plain 
+      text/css 
+      text/javascript 
+      application/javascript 
+      application/x-javascript 
+      application/xml 
+      application/json 
+      application/ld+json; 
+}