[GitHub] [incubator-pekko] pjfanning commented on issue #134: add license headers to markdown files

["pjfanning (via GitHub)" <gi...@apache.org>]

pjfanning commented on issue #134:
URL: https://github.com/apache/incubator-pekko/issues/134#issuecomment-1438263468

   I've done a little experimentation. It seems like Paradox prefers `<!---` (ending with `-->`).
   
   It seems like we may not be able to the license header at the start of every files, Paradox expects certain features to appear right at the start of the .md file so we would need in some cases to put the license header after that intro.
   
   See this example in the Druid build - https://github.com/apache/druid/edit/master/docs/operations/use_sbt_to_build_fat_jar.md
   
   This section only works properly if it appears at the start of the file.
   ```
   ---
   id: use_sbt_to_build_fat_jar
   title: "Content for build.sbt"
   ---
   ```
   
   I have hit trouble with adding the license header to some of the Pekko .md files which causes sbt-paradox to fail. I haven't had time to debug all the issues yet.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org