kruptein / planarally-docs Goto Github PK

With Kruptein/PlanarAlly#443, a great new feature has been added: rotation of shapes. This should, of course, be documented. This involves, above all, touching the select tool (and the modes section, if #34 introduces any).

However, this would, in the current setup, put the documentation ahead of the software's master / stable release branch, which might lead to misunderstandings and unnecessary bug reports. Thus, a new branch containing documentation of upcoming features should be introduced to be merged into master whenever there is a release of the software.

They're core functionality for PA, yet properties and functions are scattered around the docs. There should be a page dedicated to Shapes.
(I will write it.)

Locations have undergone a major rework during the last (and also the upcoming) releases. Yet, it is only documented in blogposts. This should be changed.

I will start to do so.

There are a few points of the 0.24.0 release that are not fully documented, yet, including:

• aura borders
• archive location
• shape annotations
• vision tool (needing full coverage)

The following needs coverage for release 2022.1:

• doors logic
• teleport logic
• draw tool restructured
• asset management: folder drop & dimension info
• server management

I haven't been around for a while so some of this stuff might alright be documented of some sorts. This issue serves as a reminder to check whether important/relevant information is already included within the docs and to include if still missing.

This issue serves as reminder that I shall document basic instructions for manual updates.

Essentially, only server/planar.sqlite, server/server_config.cfg, server/static/assets need to be preserved/carried over to the new version.

The modes, i.e. play- and build-mode, are not documented yet, despite being now integral parts of the user interface.
I will start to do so.

This might impact the sites of several tools.

The docs reference this as a DM setting, which since 0.22.0 is no longer the case.

Advanced vision settings (minimal/maximal vision) has to be documented.

In order to use https with nginx, cors_allowed_origins in /server/server_config.cfg needs to have the https://subdomain.domain.com specified that is directed to PA.

[Webserver]
# Allowed CORS origins # If not specified, only the host runnig the server is allowed
# Allowed values are: ['*'], ['some-address.xyz', 'other-address.xyz'], [] # More information on the meaning of these values can be found at
# https://python-socketio.readthedocs.io/en/latest/api.html#asyncserver-class **cors_allowed_origins = https://subdomain.domain.com**

The initiative tool is not documented, at all. It should be, though.

I will start to do so.

Floors are not documented, yet.
I will start to do so.

This might include structural changes, e.g. how Layers and Locations are presented in the docs.

There are a few points of the 0.26.0 release that are not fully documented, yet, including:

• dashboard (needing full coverage)
• erase tool
• text shapes
• disable scroll to zoom (maybe within a "touch support" section?)
• co-DM option
• mark shape as defeated
• tracker bars
• import dungeondraft *.dd2vtt / *.svg
• mac keybindings
• public_name config option
• big red border when disconnected
• unique floor names

There are a few points of the 0.24.0 release that are not fully documented, yet, including:

• hex grid support
• asset variants
• changes to initiative tool
• map tool "keep aspect ratio" functionality
• "bend" ruler functionality
• asset import/export ("backup")

The following needs coverage for the (still upcoming) release 0.27.0:

• canvas now supporting physical (mini) grid size
• player viewport on DM layer
• new initiative window
• server_config variable public_name commented by default
• copy locations
• HiDPI/Retina
• ctrl deselect
• api server disabled by default

PR should point to the next branch instead of master, as these feature are not yet released.

There are some dead links, e.g. on https://www.planarally.io/tutorial/setup/self-hosting/ two links are called "server management" and link to https://www.planarally.io/docs/dm/management/

The readme should be updated to include info on the core places where contributors can add documentation.

Additionally info should be available on how contributors can preview things locally.

The assets, notes, and marker options for the DM have yet to be documented. I will do so.

The config file is not documented, yet.
I will start to do so.

The following needs coverage for release 2022.2:

• import/export
• colour picker
• server configuration: log rotation & import chunk size

I haven't been around for a while so some of this stuff might alright be documented of some sorts. This issue serves as a reminder to check whether important/relevant information is already included within the docs and to include if still missing.

The following needs coverage for release 0.29.0:

• dice roller tool
• polygon editing
• server admin cli

Also check:

• handling of SVG (updated/modified with this release)

I haven't been around for a while so some of this stuff might alright be documented of some sorts. This issue serves as a reminder to check whether important/relevant information is already included within the docs and to include if still missing.

On this page in the documentation "https://www.planarally.io/docs/dm/light-shadows/" the link "first session tutorial" points here "https://www.planarally.io/tutorial/in-game/first-session/", which gives a "404 - not found" page.

I modeled my compose file after the example given.

planarally:
    image: kruptein/planarally:latest
    container_name: planarally
    restart: unless-stopped
    networks:
      - traefik_network
    volumes:
      - /mnt/planarally/data:/planarally/data/
      - /mnt/planarally/static/assets:/planarally/static/assets/
    labels:
      - traefik.http.services.pa.loadbalancer.server.scheme=https
      - traefik.http.services.pa.loadbalancer.server.port=8000
      - traefik.enable=true
      - traefik.docker.network=web
      - traefik.http.routers.pa-http.service=pa
      - traefik.http.routers.pa-http.rule=Host(`pa.domain.tdl`)
      - traefik.http.routers.pa-http.entrypoints=web
      - traefik.http.routers.pa.service=pa
      - traefik.http.routers.pa.rule=Host(`pa.domain.tdl`)
      - traefik.http.routers.pa.entrypoints=websecure
      - traefik.http.routers.pa.tls=true
      - traefik.http.routers.pa.tls.certresolver=cloudflare
      - traefik.http.routers.pa.tls.domains[0].main=domain.tdl
      - traefik.http.routers.pa.tls.domains[0].sans=*domain.tdl
      - traefik.http.middlewares.sslheader.headers.customrequestheaders.X-Forwarded-Proto=https
      # these are required, this forces the websocket to forward over https
      - traefik.http.routers.pa.middlewares=ssl-header
      - traefik.http.middlewares.ssl-header.headers.customrequestheaders.X-Forwarded-Proto=https

Looking at the Traefik dashboard it says it is running, but I get a time out when I go to "pa.domain.tdl" (which doesn't happen when I go to whoami.domain.tdl, the sample service in the traefik tutorial).

Any suggestions on where to look at what I might have done wrong?

For more context I am running Traefik: v2.4

This Feature is not merged yet with PA releases and there for I don't believe this feature's docs should be in the in the master branch.

Proposal:

Docs should have a seperate dev branch that matches pace with the dev branch for PA itself as well as a seperate branch for PRs adding new features.

I understand it's more work on branch management, but personally I dont want to be the one to tell a user asking for help that a feature that's documented does not exist yet.

The following needs coverage for release 0.28.0:

• configurable background on map layer
• active player can advance initiative
• annotations support HTML subset

A Tutorial on some more complex lighting setups (e.g. emulating RTS style fow) would be helpful.