search

iho-ohi / S-102-Product-Specification

It is opened to develop S-102 Bathymetric Surface Product Specification. The contents of this repository are not offical publication in force, therefore please check the final version on the IHO website.
Other
27 stars 11 forks source link

Need a Tutorial for PT Members #27

Closed hasel001 closed 5 months ago

hasel001 commented 1 year ago

Discussions during S-102PT12 called for the creation of a GitHub tutorial. With help from @RohdeBSH and @giumas among several others, I added this page to the repo wiki.

This issue serves as a central point for comments, questions, and suggestions to improve the tutorial. All ideas are welcome and encouraged.

rmalyankar commented 11 months ago

Is it possible to add an explanation/confirmation of how to generate documents in a fork of the repository?

The idea is to generate documents from updated sources for 2.3.0, without affecting anything in the common "iho-ohi/S-102-Product-Specification" repository, until I am ready to create a pull request to merge my updates with 2.3.0 in the Developing branch of the common S-102 repository.

It might be as simple as enabling and applying the same workflow in the forked repository, but before I do that I thought I'd check if there are any dependencies or prerequisites in the workflow, or if it needs customization.

Or are all updates required to be made in a new branch of the common repository (created from the Developing branch so it has the 2.3.0 sources)?

RohdeBSH commented 11 months ago

Hi @rmalyankar ,

As far as I understand, this is not possible in a fork. You have to install Metanorma, check out your fork locally and let Metanorma build the document in this directory. The instructions for this are on the Metanorma website.

If I'm wrong, feel free to let me know. I find my current way cumbersome as well.

hasel001 commented 5 months ago

Satisfied per discussion in PT16.