Skip to content

DOCS: Cookies section - https://github.com/ether/etherpad-lite/issues/3563#3921

Merged
muxator merged 2 commits intoether:developfrom
tiblu:develop
Apr 24, 2020
Merged

DOCS: Cookies section - https://github.com/ether/etherpad-lite/issues/3563#3921
muxator merged 2 commits intoether:developfrom
tiblu:develop

Conversation

@tiblu
Copy link
Copy Markdown
Contributor

@tiblu tiblu commented Apr 22, 2020

DOCS: Cookies section

Document cookie usage in Etherpad.

Related issue:

@tiblu tiblu mentioned this pull request Apr 22, 2020
Closed
2 tasks
@muxator muxator linked an issue Apr 23, 2020 that may be closed by this pull request
DOCS: Document cookie usage in Etherpad - Waiting on Final Edits #3563
Closed
2 tasks
@muxator muxator added the docs label Apr 23, 2020
@muxator muxator added this to the 1.8.3 milestone Apr 23, 2020
@muxator
Copy link
Copy Markdown
Contributor

muxator commented Apr 23, 2020

  1. This version is better than the issue at DOCS: Document cookie usage in Etherpad - Waiting on Final Edits #3563: you also added hyperlinks to the code 👍

  2. I have added another table mentioning sessionID, but I am not really sure that is the correct form. It seems a "normal" cookie, while in reality it is more a Frankenstein. I did not want to lose the information we gathered, though. If we do not find a better presentation we can remove it.

  3. From DOCS: Document cookie usage in Etherpad - Waiting on Final Edits #3563 (comment)

    Could not find a way to test the docs generation. Checked for Travis files and package.json for documentation generation scripts, but could not find how docs are generated.

    There is a Makefile at the top level. Issue make docs, and the docs will be generated at doc/out.

  4. I have generated the docs with the above command, and I have discovered that the library that is used for Markdown rendering (vendorized in Etherpad's repo here) is ancient, and does not even support HTML tables 😭
    Look:

    image

@muxator muxator mentioned this pull request Apr 23, 2020
Merged
@muxator
Copy link
Copy Markdown
Contributor

muxator commented Apr 23, 2020 •
edited
Loading

I have updated Marked (the library used by the doc generator to render Markdown) and at least now tables are rendered as such:

image

You can replicate it updating to the last commit of this PR and launching make docs again.

But it's still horrendous:

  1. the hyperlinks do not work (clicking on a title in the TOC won't bring you anywhere)
  2. the vertical alignment of the table is centered, and it is very hard to read
  3. some borders/fill in the table cell similar to what Github/Gitlab do would help the legibility

This also affects the docker documentation, that was improved in #3873, and now is suffering of extreme ugliness.

@muxator muxator mentioned this pull request Apr 24, 2020
Merged
muxator added a commit that referenced this pull request Apr 24, 2020
@muxator
doc: remove old vendorized marked module and replace with 0.8.2
db77302 
This change is needed because in 1.8.3 we are going to introduce Markdown tables
in the documentation (#3873 and #3921), and the old marked version did not
support generating them.

Instead of committing the marked source code here, we live install from npm if
needed via the Makefile.

n.b.: at the time of this change, marked latest version is 1.0.0, released a few
      days ago. I am updating to the version immediately before that (0.8.2),
      because in 1.0.0 the hyperlinks in the Table of Contents do not work
      (probably a bug in that version).
@muxator muxator force-pushed the develop branch 4 times, most recently from c2b9635 to d82d123 Compare April 24, 2020 01:00
@muxator
Copy link
Copy Markdown
Contributor

muxator commented Apr 24, 2020

Updated the documentation generation library with #3929 (obviously it was not straightforward).
The tables will now be rendered. They'll be ugly, but we can live with it.

Merged, thanks.

@muxator muxator merged commit 1aebbe8 into ether:develop Apr 24, 2020
muxator pushed a commit to tiblu/etherpad-lite that referenced this pull request May 3, 2020
@tiblu
docs: basic styles for tables
d9a32e8 
This is a cosmetic fix for PR ether#3921 (109aa2d).
Discussion on ether#3563
muxator pushed a commit to tiblu/etherpad-lite that referenced this pull request May 3, 2020
@tiblu
docs: basic styles for tables
40d21e4 
This is a cosmetic fix for PR ether#3921 (109aa2d).
Discussion on ether#3563
muxator pushed a commit that referenced this pull request May 3, 2020
@tiblu @muxator
docs: basic styles for tables
c074dfe 
This is a cosmetic fix for PR #3921 (109aa2d).
Discussion on #3563
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docs

Projects

None yet

Milestone

1.8.3

Development

Successfully merging this pull request may close these issues.

DOCS: Document cookie usage in Etherpad - Waiting on Final Edits

2 participants

@tiblu @muxator