modern-pascal/modern-pascal-introduction

Conflicting instructions about where to edit page

Closed this issue · 1 comments

phormio commented

Please consider this screenshot, which shows the bottom of https://castle-engine.io/modern_pascal:

Image

There are conflicting instructions for editing the document, which I have highlighted with red rectangles.

michaliskambi commented

This is actually OK :) You really can follow any of these instructions, they will result in a PR that is easy for me to apply (in both places). I use AsciiDoctor in both places (modern-pascal/modern-pascal-introduction, castle-engine/cge-www).

Details:

  1. The first instruction recommends to edit in https://github.com/modern-pascal/modern-pascal-introduction repository, which is dedicated to the "Modern Object Pascal Introduction for Programmers".

    When I edit things there, I synchronize them to castle-engine/cge-www repo. The main English text is copied to https://github.com/castle-engine/cge-www/blob/master/htdocs/doc/modern_pascal.adoc?plain=1 , so it is rendered as part of Castle Game Engine website with CGE styling. The synchronization is one make update-cge-www command, https://github.com/modern-pascal/modern-pascal-introduction/blob/master/Makefile#L44 .

  2. The second instruction is something we display at the bottom of most CGE webpages (maintained in AsciiDoctor, and most of them are in AsciiDoctor now). E.g. https://castle-engine.io/install has the same footer as https://castle-engine.io/modern_pascal .

    This means I welcome improvements to any pages in https://github.com/castle-engine/cge-www/tree/master/htdocs/doc . If you happen to modify modern_pascal.adoc, I will just synchronize the changes "back" to https://github.com/modern-pascal/modern-pascal-introduction , since it's just the same AsciiDoctor contents.

I really wanted to maintain https://github.com/modern-pascal/modern-pascal-introduction/ as a separate entity (it's independent from the Castle Game Engine project in the end), but also display https://castle-engine.io/modern_pascal in a style consistent with other CGE pages. Hence this result.