Closed archaeogeek closed 2 years ago
ronaldtse
commented
2 years ago Thanks @archaeogeek for raising this issue.
By any chance you have a "Gemfile" in the document folder? Typically a user should not need to do anything with the "sassc" gem.
@CAMOBAP can you take a look at this?
CAMOBAP
commented
2 years ago Last ci looks good, @ronaldtse you are right, it's critical to check Gemfile here
@archaeogeek could you please share your Gemfile?
archaeogeek
commented
2 years ago Thanks for the prompt response. I should have said initially that I am following the "simple adoption" approach from https://www.metanorma.org/builder/topics/simple-adoption/ and all I have is a metanorma.yml file, which is based almost exactly on the default one listed:
metanorma_name: generic
organization_name_short: myorg
organization_name_long: My Org Name
document_namespace: https://www.metanorma.org/standards/generic
xml_root_tag: 'generic-standard'
logo_path: /config/mylogo.jpg
logo_paths: []
validate_rng_file: lib/asciidoctor/generic/generic.rng
htmlcoverpage: lib/isodoc/generic/html/html_generic_titlepage.html
htmlintropage: lib/isodoc/generic/html/html_generic_intro.html
htmlstylesheet: lib/isodoc/generic/html/htmlstyle.scss
scripts: lib/isodoc/generic/html/scripts.html
standardstylesheet: lib/isodoc/generic/html/generic.scss
header: lib/isodoc/generic/html/header.html
wordcoverpage: lib/isodoc/generic/html/word_generic_titlepage.html
wordintropage: lib/isodoc/generic/html/word_generic_intro.html
wordstylesheet: lib/isodoc/generic/html/wordstyle.scss
#i18nyaml: lib/isodoc/generic/html/i18n-en.yml
boilerplate: lib/asciidoctor/generic/boilerplate.xml
docid_template: "{{ organization_name_short }} {{ docnumeric }}"
published_stages: ["published", "withdrawn"]
committees: []
relations: []
stage_abbreviations:
draft-proposal:
draft-development:
draft-testing:
draft-implementation:
in-force:
retired:
metadata_extensions: []
doctypes: ['standard']
default_doctype: standard
termsdefs_titles:
- Terms and definitions
- Terms, definitions, symbols and abbreviated terms
- Terms, definitions, symbols and abbreviations
- Terms, definitions and symbls
- Terms, definitions and abbreviations
- Terms, definitions and abbreviated terms
symbols_titles:
- Symbols and abbreviated terms
- Symbols
- Abbreviated terms
- Abbreviations
normref_titles:
- Normative references
bibliography_titles:
- BibliographyThen in my asciidoc file I just have :customize: metanorma.yml under the title.
The Simple Adoption approach with the yml file implies that's all I need- rather than attempting the ruby gem approach (this being my first attempt at metanorma and ruby)- unless I've missed something in the instructions?
CAMOBAP
commented
2 years ago @archaeogeek thanks for information
@ronaldtse to be honest I didn't try such scenario of using metanorma. Are it still valid one, if so it looks like documentation is outdated because we don't use scss in production as far as I remember, could you please confirm?
CAMOBAP
commented
2 years ago @ronaldtse I'm not sure how to update this documentation, we need to report task about it in https://github.com/metanorma/metanorma.com
@opoudjis maybe you can help and suggest some workaround here? maybe we can just drop htmlstylesheet, standardstylesheet, wordstylesheet?
opoudjis
commented
2 years ago Dear everybody,
The gem sassc is used to compile SCSS stylesheets into CSS stylesheets; SCSS allows us to inject variables (such as the names of fonts) into the stylesheet.
When we release standardised gems, part of our release involves compiling SCSS into CSS. Because we wanted to remove the dependency of Metanorma on sassc by default, when we compile the SCSS into CSS, we remove the need for sassc.
If you pull a pre-release Metanorma flavour gem from github, you find you have to include sassc into any Gemfile, because the CSS stylesheets are not checked in to Github: they are only compiled on release.
If you build a brand new flavour, as is the case here, you have two options:
The third option of dropping htmlstylesheet, standardstylesheet, wordstylesheet... I would not advise, because styling matters; without a stylesheet, output is going to look pretty bad.
I'll mention sassc now as a requirement in https://www.metanorma.org/builder/topics/simple-adoption/ ; the dropping of the sassc gem requirement is recent, and this documentation hasn't been updated to reflect that.
opoudjis
commented
2 years ago @CAMOBAP I can't really help with docker, because I don't know my way around it. @archaeogeek the simplest thing for you to do, rather than try and get sassc to work, is to rename the scss stylesheets as css stylesheets, and replace any instances of variables (e.g. font-family:$monospacefont;) with full values.
CAMOBAP
commented
2 years ago @opoudjis thanks a lot for workaround, this is more then enough
@archaeogeek could you please follow suggested workaround, or please let us know if this isn't option for you.
@ronaldtse I have two notes:
archaeogeek
commented
2 years ago @opoudjis / @CAMOBAP Thanks for pursuing this. I just wanted to clarify something- if I am using the metanorma.yml approach and docker, when you say "rename the scss stylesheets as css stylesheets", presumably you mean making the changes inside the docker container and not simply changing the references to them in my local yml file?
CAMOBAP
commented
2 years ago @archaeogeek as fat as I understood metanorma.yml comes from your host machine, so it should be not a problem to modify it.
opoudjis
commented
2 years ago @CAMOBAP I've already done the documentation update: https://github.com/metanorma/metanorma.org/commit/41e2cde0c7633940112f1b5e2be15cdcdd749ce6
CAMOBAP
commented
2 years ago @opoudjis thanks a lot, BTW how do you think should we include sass into our docker image?
archaeogeek
commented
2 years ago Hello, it has taken me a while to figure out how to do it, but I have succeeded in trying the work-around of renaming the *.scss files to *.css inside the docker container, and that does seem to fix my problem.
For future reference, I did the following (there might be a better approach but it worked):
docker run -it --entrypoint bash -v "$(pwd)":/metanorma/ metanorma/mn:latestdocker exec -it {mycontainername} /bin/bash/usr/local/bundle/gems/metanorma-generic-1.11.1/lib/isodoc/generic/htmldocker exec -it -w /metanorma {mycontainername} metanorma compile -t generic -x html 1037-uk-gemini-standard-2-3-revised.adocSince that seems to work OK, I think I can build a docker-compose file that includes the css versions of the files to make this a bit easier to reproduce until there's a fix in the standard images.
Thanks for all your help!
ronaldtse
commented
2 years ago @archaeogeek thank you so much for the update and for charging through. We will update our documentation to reflect your experience and incorporate the necessary changes in our next release to make it easier. Thanks!
opoudjis
commented
2 years ago As for including sassc in docker... i think the answer is yes, but I don't remember why sassc was considered harmful to begin with. @ronaldtse ?
Because I don't understand docker, could I ask that @CAMOBAP do the documentation update? I'm assuming this needs to be a new page under https://www.metanorma.org/builder/ , rather than part of https://www.metanorma.org/install/docker/ , but I'm actually not sure at all.
ronaldtse
commented
2 years ago sassc was considered harmful
@CAMOBAP can you please help update documentation? Thanks.
CAMOBAP
commented
2 years ago @ronaldtse https://github.com/metanorma/metanorma.org/pull/535 done
Hello, this is my first foray into metanorma and I've hit a problem. I'm running the docker container on Ubuntu 20.04, and am running the following command:
docker run -it -v "$(pwd)":/metanorma/ -w /metanorma metanorma/mn:latest metanorma compile -t generic -x html myadoc.adocThis fails with the following error:
However if I run the following instead:
docker run -it -v "$(pwd)":/metanorma/ -w /metanorma metanorma/mn:latest metanorma compile -t iso -x html myadoc.adocThen the command finishes.Note that I get the same results regardless of which metanorma container I use.
I'm very unfamiliar with ruby, but OK with command line debugging and generally poking around in docker containers, so I dropped into a running container but couldn't find sassc amongst the gems.
I have attempted to manually install the sassc gem using
gem install sasscand while that seemed to complete without error it didn't solve the problem. Variations onbundle installalso failed but I really don't know the best approach here so it's possible I didn't do this correctly.I'd be very grateful for any assistance people can provide- step by step instructions would be really nice if there's any further debugging I can do to help resolve the issue.
Thanks in advance
Jo