Skip to content

fix(revert): move helm README to docs #4044

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

Merged
merged 1 commit into from
Sep 14, 2021
Merged

fix(revert): move helm README to docs #4044

merged 1 commit into from
Sep 14, 2021

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Aug 25, 2021

This reverts the revert now that we fixed the upstream issue with the docs.

Fixes N/A

TODOs

  • address Bruno's comments
  • helm.md should be under Install
  • fix link for Helm package manager
  • fix badges using the same format in =README=

@jsjoeio jsjoeio requested a review from a team as a code owner August 25, 2021 19:17
@codecov
Copy link

codecov bot commented Aug 25, 2021

Codecov Report

Merging #4044 (7a14127) into main (1d4ffda) will not change coverage.
The diff coverage is n/a.

❗ Current head 7a14127 differs from pull request most recent head d650894. Consider uploading reports for the commit d650894 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4044   +/-   ##
=======================================
  Coverage   64.22%   64.22%           
=======================================
  Files          36       36           
  Lines        1873     1873           
  Branches      379      379           
=======================================
  Hits         1203     1203           
  Misses        569      569           
  Partials      101      101           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1d4ffda...d650894. Read the comment docs.

@github-actions
Copy link

github-actions bot commented Aug 25, 2021

✨ Coder.com for PR #4044 deployed! It will be updated on every commit.

@jsjoeio jsjoeio changed the title revert revert wip: revert revert Aug 25, 2021
@jsjoeio jsjoeio changed the title wip: revert revert revert revert Aug 25, 2021
@jsjoeio
Copy link
Contributor Author

jsjoeio commented Aug 25, 2021

Note to self: we think this is caused by handlerbars (in the markdown parsing used on coder com ). Going to leave this open for now and address once we fix upstream

@jsjoeio jsjoeio marked this pull request as draft August 25, 2021 20:02
@BrunoQuaresma
Copy link
Contributor

BrunoQuaresma commented Aug 25, 2021

@jsjoeio I added table support on this PR https://github.com/cdr/m/pull/9700, but I noticed a few things:

  • TL;DR is a title, and it is being displayed on the table of content. Can we remove that or add a more "descriptive" title like "Usage" or "Quick usage"? Idk if having TL;DR is acceptable. Maybe it is just a personal preference.
  • The description field on the table is empty. Maybe it is better to remove the column.

@BrunoQuaresma
Copy link
Contributor

@jsjoeio I wrapped the badges in links like GH does so they are displayed inline. GH code screenshot:
Screen Shot 2021-08-25 at 18 54 52

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Aug 25, 2021

TL;DR is a title, and it is being displayed on the table of content. Can we remove that or add a more "descriptive" title like "Usage" or "Quick usage"? Idk if having TL;DR is acceptable. Maybe it is just a personal preference.

Sure! I just copied this over so I have no preference

The description field on the table is empty. Maybe it is better to remove the column.

Hmm...I'm going to ask @jawnsy about that because there may be a reason we need to keep it

@jsjoeio jsjoeio self-assigned this Aug 25, 2021
@jsjoeio jsjoeio changed the title revert revert revert revert: move helm README to docs Aug 25, 2021
@jsjoeio jsjoeio added the docs Documentation related label Aug 25, 2021
@jsjoeio jsjoeio added this to the 3.12.0 milestone Aug 25, 2021
@jsjoeio jsjoeio force-pushed the jsjoeio-revert-revert branch from fe05e2e to ce0c2cd Compare August 26, 2021 23:17
@jsjoeio jsjoeio marked this pull request as ready for review September 2, 2021 18:11
@jsjoeio jsjoeio changed the title revert revert: move helm README to docs fix(revert): move helm README to docs Sep 2, 2021
@jsjoeio
Copy link
Contributor Author

jsjoeio commented Sep 3, 2021

Hmmm...something is not right here

https://codercom-enql9v6o6-codercom.vercel.app/docs/code-server/latest

image

@jsjoeio jsjoeio marked this pull request as draft September 3, 2021 18:35
@jawnsy
Copy link
Contributor

jawnsy commented Sep 3, 2021

@jsjoeio I checked the Inspect page (link shows up in the build/deploy output), it still shows that there's something wrong with the curly braces {} -- @bpmct did you merge the handlebars removal change?

[GET] /docs/code-server/latest
14:03:57:09
info - Building code-server/latest
info - Value of CODE_SERVER_DOCS_MAIN_BRANCH is "ce0c2cd0268a2090e903a8047dfd063bd6c75763".
info - Using "ce0c2cd0268a2090e903a8047dfd063bd6c75763" as main content source.
2021-09-03T21:03:57.761Z	7bff6c39-d6eb-4178-bdf3-530514c888ca	ERROR	Error: Parse error on line 285:
...ation    image: {{ .Values.image.reposi
----------------------^
Expecting 'ID', 'STRING', 'NUMBER', 'BOOLEAN', 'UNDEFINED', 'NULL', 'DATA', got 'SEP'
    at Parser.parseError (/var/task/product/coder.com/site/node_modules/handlebars/dist/cjs/handlebars/compiler/parser.js:267:19)
    at Parser.parse (/var/task/product/coder.com/site/node_modules/handlebars/dist/cjs/handlebars/compiler/parser.js:336:30)
    at parseWithoutProcessing (/var/task/product/coder.com/site/node_modules/handlebars/dist/cjs/handlebars/compiler/base.js:46:33)
    at HandlebarsEnvironment.parse (/var/task/product/coder.com/site/node_modules/handlebars/dist/cjs/handlebars/compiler/base.js:52:13)
    at compileInput (/var/task/product/coder.com/site/node_modules/handlebars/dist/cjs/handlebars/compiler/compiler.js:508:19)
    at ret (/var/task/product/coder.com/site/node_modules/handlebars/dist/cjs/handlebars/compiler/compiler.js:517:18)
    at markdownParser (/var/task/product/coder.com/site/.next/server/pages/docs/[[...slug]].js:1538:54)
    at runMicrotasks (<anonymous>)
    at processTicksAndRejections (internal/process/task_queues.js:97:5)
    at async /var/task/product/coder.com/site/.next/server/pages/docs/[[...slug]].js:6788:23
RequestId: 7bff6c39-d6eb-4178-bdf3-530514c888ca Error: Runtime exited with error: exit status 1
Runtime.ExitError

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Sep 3, 2021

doesn't look like it 😢

https://github.com/cdr/m/pull/9696

@BrunoQuaresma
Copy link
Contributor

Taking a look at why the check returns an error but the action is returning green.

@BrunoQuaresma
Copy link
Contributor

I re-run the check job and now it is working. Idk if it was using an old version of the script 🤔

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Sep 3, 2021

I re-run the check job and now it is working. Idk if it was using an old version of the script 🤔

🤷‍♂️ I'll keep an eye out.

@BrunoQuaresma can we merge https://github.com/cdr/m/pull/9696?

@jsjoeio jsjoeio force-pushed the jsjoeio-revert-revert branch from ce0c2cd to f84614b Compare September 7, 2021 21:48
@BrunoQuaresma
Copy link
Contributor

@jsjoeio yeap! That is good for me.

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Sep 8, 2021

I need to double-check this branch. I think I messed it up yesterday when I thought I was on another branch.

@jsjoeio jsjoeio modified the milestones: 3.12.0, 3.12.1 Sep 9, 2021
@jsjoeio jsjoeio force-pushed the jsjoeio-revert-revert branch from f84614b to 49adba0 Compare September 13, 2021 21:02
@jsjoeio
Copy link
Contributor Author

jsjoeio commented Sep 13, 2021

Looks like it's all working now!

image

@jsjoeio jsjoeio force-pushed the jsjoeio-revert-revert branch from 49adba0 to d650894 Compare September 13, 2021 21:16
@jsjoeio jsjoeio marked this pull request as ready for review September 13, 2021 21:16
@jsjoeio jsjoeio merged commit 8e08775 into main Sep 14, 2021
@jsjoeio jsjoeio deleted the jsjoeio-revert-revert branch September 14, 2021 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants