You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "pjfanning (via GitHub)" <gi...@apache.org> on 2023/01/30 20:56:34 UTC
[GitHub] [incubator-pekko] pjfanning opened a new issue, #134: add license headers to markdown files
pjfanning opened a new issue, #134:
URL: https://github.com/apache/incubator-pekko/issues/134
ASF generally prefer that all files have Apache license headers - not just the source files.
There are js and html files in the docs dir too - these probablu would be better with license headers too.
sbt-paradox may work differently from Github.
Github supports:
```
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
license agreements; and to You under the Apache License, version 2.0:
https://www.apache.org/licenses/LICENSE-2.0
This file is part of the Apache Pekko project, derived from Akka.
-->
```
--
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.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
[GitHub] [incubator-pekko] pjfanning commented on issue #134: add license headers to markdown files
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on issue #134:
URL: https://github.com/apache/incubator-pekko/issues/134#issuecomment-1509825157
@mdedetrich this may not be needed based on https://issues.apache.org/jira/browse/LEGAL-634 comments
--
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
[GitHub] [incubator-pekko] mkurz commented on issue #134: add license headers to markdown files
Posted by "mkurz (via GitHub)" <gi...@apache.org>.
mkurz commented on issue #134:
URL: https://github.com/apache/incubator-pekko/issues/134#issuecomment-1409326448
I see you use sbt-header, have a look how we do that in Play-Framework (specially the `md` filetype):
https://github.com/playframework/playframework/blob/66f69ce73a97bdf5a3157aea3b991a7b979c1799/project/BuildSettings.scala#L53-L76
--
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
[GitHub] [incubator-pekko] pjfanning commented on issue #134: add license headers to markdown files
Posted by "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
[GitHub] [incubator-pekko] mdedetrich commented on issue #134: add license headers to markdown files
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on issue #134:
URL: https://github.com/apache/incubator-pekko/issues/134#issuecomment-1509885401
Okay let's close the issue once it's clarified then.
--
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
[GitHub] [incubator-pekko] mdedetrich commented on issue #134: add license headers to markdown files
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on issue #134:
URL: https://github.com/apache/incubator-pekko/issues/134#issuecomment-1509700998
I would presume that similar to conf files we can use the SPDIF license format?
--
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
[GitHub] [incubator-pekko] pjfanning closed issue #134: add license headers to markdown files
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning closed issue #134: add license headers to markdown files
URL: https://github.com/apache/incubator-pekko/issues/134
--
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