Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Polish contribute page, css list nits, client-config & docker fixes #901

Merged
merged 12 commits into from
Jun 5, 2022

Conversation

ix5
Copy link
Member

@ix5 ix5 commented Jun 5, 2022

Checklist

  • All new and existing tests are passing
  • (If adding features:) I have added tests to cover my changes
  • (If docs changes needed:) I have updated the documentation accordingly.
  • I have added an entry to CHANGES.rst because this is a user-facing change or an important bugfix
  • I have written proper commit message(s)

What changes does this Pull Request introduce?

docs:

  • contrib/docs: Add live rST editor link, nit
  • [nit] client-config: Mark strings with quotes
  • testing-client: Update make docker cmds
  • css: Indent ordered lists as well, cleanup
  • contrib: More purpose-oriented TOC
  • contrib: Add commit msg examples, checklist
  • contrib/docs: Mention commento contrib, nits
  • [nit] test-server: Correct make command

MANIFEST.in: Add Javascript .map files

Those files allow for de-obfuscating minified webpack-assembled bundles and tracing function calls back to the source files when used in browser debuggers.

Makefile: apidoc: Also render private APIs

Marking /admin and /demo endpoints as private is semantically correct, but since these docs are aimed at developers anyway, document them in any case.

contrib: Add sample cfg

To be used as a base for e.g. Docker instructions.

docs, README: Update Docker instructions

Mention the official image and be a bit more clear about config requirements.

ix5 added 12 commits June 5, 2022 20:22
Those files allow for de-obfuscating minified
webpack-assembled bundles and tracing function calls back to
the source files when used in browser debuggers.
Marking /admin and /demo endpoints as private is
semantically correct, but since these docs are aimed at
developers anyway, document them in any case.
To be used as a base for e.g. Docker instructions.
Mention the official image and be a bit more clear about
config requirements.
@ix5 ix5 added docs Documentation of the project meta Concerning the general direction and organisation of the project improvement Not a new feature, but makes Isso more pleasant to use labels Jun 5, 2022
@ix5 ix5 added this to the 0.13 milestone Jun 5, 2022
@ix5 ix5 merged commit 76ff234 into isso-comments:master Jun 5, 2022
@ix5 ix5 deleted the docs-nits branch June 5, 2022 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation of the project improvement Not a new feature, but makes Isso more pleasant to use meta Concerning the general direction and organisation of the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant