cue icon indicating copy to clipboard operation
cue copied to clipboard

cuelang.org: theme/docsy: edit page link doesn't work for generated pages

Open cueckoo opened this issue 4 years ago • 2 comments

Originally opened by @xinau in https://github.com/cuelang/cuelang.org/issues/43

since some pages are being generated/copied from the cuelang/cue repository the edit page button points to missing files on github for cuelang/cuelang.org

affected pages:

  • https://cuelang.org/docs/references/spec/
  • https://cuelang.org/docs/tutorials/tour/

a possible solution could be to override the href via the metadata in the generated markdown file and a custom template

cueckoo avatar Jul 03 '21 11:07 cueckoo

Original reply by @NReilingh in https://github.com/cuelang/cuelang.org/issues/43#issuecomment-792192089

Related to this, somewhere in contributing or readme it should say where one would go if they would like to submit an edit PR to, say, the tutorial. I wanted to fix some typos but gave up since it doesn't seem to be on GitHub.

cueckoo avatar Jul 03 '21 11:07 cueckoo

Original reply by @myitcv in https://github.com/cuelang/cuelang.org/issues/43#issuecomment-797526704

Thanks for flagging this @xinau and @NReilingh.

@xinau - we'd happily accept/explore a PR that looked at fixing this "properly" along the lines you suggest. Alternatively in the short term we could simply include a comment in each file stating its source.

@NReilingh thank you for your recent changes, and sorry you couldn't find the spec/tutorial link. The are as follows:

  • Spec: https://github.com/cuelang/cue/blob/master/doc/ref/spec.md
  • Tour: https://github.com/cuelang/cue/tree/master/doc/tutorial/basics
  • Kubernetes: https://github.com/cuelang/cue/tree/master/doc/tutorial/kubernetes

cueckoo avatar Jul 03 '21 11:07 cueckoo

This has been superseded by the new https://cuelang.org site. At the bottom of each page there is a means of reporting an issue for the current page:

327094336-885b9636-a62e-4878-b893-c199960b67dd

myitcv avatar May 01 '24 11:05 myitcv