You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "laglangyue (via GitHub)" <gi...@apache.org> on 2023/12/13 13:27:43 UTC

[D] How build the Document? [incubator-pekko-samples]

GitHub user laglangyue created a discussion: How build the Document?

I understand that each sub project is an independent project. Is there any relevant guidance on how docs gen generates the final document?
Pekko samples guide users on how to use Pekko, but is there a lack of guidance in Pekko samples?
do we need a guide like https://spark.apache.org/developer-tools.html?

GitHub link: https://github.com/apache/incubator-pekko-samples/discussions/91

----
This is an automatically sent email for notifications@pekko.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@pekko.apache.org


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


Re: [D] How build the document(docs-gen)? [incubator-pekko-samples]

Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
GitHub user pjfanning edited a comment on the discussion: How build the document(docs-gen)?

I must admit that I don't quite understand what you are getting at.

The docs in `docs-gen` are built to https://nightlies.apache.org/pekko/docs/pekko-samples/main-snapshot/docs/

Have a look at https://github.com/apache/incubator-pekko-samples/blob/main/.github/workflows/publish-nightly.yml to see the steps.

The main bit is:
```
cd docs-gen
sbt paradox
```

If this is not what you asking about, could you rephrase the question you are asking to make it more clear?


GitHub link: https://github.com/apache/incubator-pekko-samples/discussions/91#discussioncomment-7842464

----
This is an automatically sent email for notifications@pekko.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@pekko.apache.org


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


Re: [D] How build the Document? [incubator-pekko-samples]

Posted by "laglangyue (via GitHub)" <gi...@apache.org>.
GitHub user laglangyue edited a discussion: How build the Document?

I understand that each sub project is an independent project. Is there any relevant guidance on how docs gen generates the final document?
Pekko samples guide users on how to use Pekko, but is there a lack of guidance in Pekko samples?
do we need a guide like https://spark.apache.org/developer-tools.html? when I build spark, it's useful.

GitHub link: https://github.com/apache/incubator-pekko-samples/discussions/91

----
This is an automatically sent email for notifications@pekko.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@pekko.apache.org


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


Re: [D] How build the document(docs-gen)? [incubator-pekko-samples]

Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
GitHub user pjfanning added a comment to the discussion: How build the document(docs-gen)?

I must admit that I don't quite understand what you are getting at.

The docs in `docs-gen` are built to https://nightlies.apache.org/pekko/docs/pekko-samples/main-snapshot/docs/

Have a look at https://github.com/apache/incubator-pekko-samples/blob/main/.github/workflows/publish-nightly.yml to see the steps.

The main bit is:
```
cd docs-gen
sbt paradox
```


GitHub link: https://github.com/apache/incubator-pekko-samples/discussions/91#discussioncomment-7842464

----
This is an automatically sent email for notifications@pekko.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@pekko.apache.org


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


Re: [D] How build the document(docs-gen)? [incubator-pekko-samples]

Posted by "laglangyue (via GitHub)" <gi...@apache.org>.
GitHub user laglangyue edited a discussion: How build the document(docs-gen)?

I understand that each sub project is an independent project. Is there any relevant guidance on how docs gen generates the final document?
Pekko samples guide users on how to use Pekko, but is there a lack of guidance in Pekko samples?
do we need a guide like https://spark.apache.org/developer-tools.html? when I build spark, it's useful.

GitHub link: https://github.com/apache/incubator-pekko-samples/discussions/91

----
This is an automatically sent email for notifications@pekko.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@pekko.apache.org


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


Re: [D] How build the document(docs-gen)? [incubator-pekko-samples]

Posted by "laglangyue (via GitHub)" <gi...@apache.org>.
GitHub user laglangyue added a comment to the discussion: How build the document(docs-gen)?

Thank you for your enthusiastic answer. BTW, I use java 17 and use `export SBT_OPTS="-Xmx2G"` to avoid OOM.
I mean that do we need to explain this project to beginners in Readme.md? I am currently learning Pekko (akka) through this project, and maybe I will do some work for Pekko sample cqrs

GitHub link: https://github.com/apache/incubator-pekko-samples/discussions/91#discussioncomment-7842753

----
This is an automatically sent email for notifications@pekko.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@pekko.apache.org


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


Re: [D] How build the document(docs-gen)? [incubator-pekko-samples]

Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
GitHub user pjfanning added a comment to the discussion: How build the document(docs-gen)?

Like almost any open source project, the docs can always with do with improving. The project is volunteer driven and PRs are always welcome.

GitHub link: https://github.com/apache/incubator-pekko-samples/discussions/91#discussioncomment-7842824

----
This is an automatically sent email for notifications@pekko.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@pekko.apache.org


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


Re: [D] How build the document(docs-gen)? [incubator-pekko-samples]

Posted by "laglangyue (via GitHub)" <gi...@apache.org>.
GitHub user laglangyue edited a discussion: How build the document(docs-gen)?

I understand that each sub project is an independent project. Is there any relevant guidance on how docs gen generates the final document?
Pekko samples guide users on how to use Pekko, but is there a lack of guidance in Pekko samples?

GitHub link: https://github.com/apache/incubator-pekko-samples/discussions/91

----
This is an automatically sent email for notifications@pekko.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@pekko.apache.org


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


Re: [D] How build the document(docs-gen)? [incubator-pekko-samples]

Posted by "laglangyue (via GitHub)" <gi...@apache.org>.
GitHub user laglangyue closed a discussion: How build the document(docs-gen)?

I understand that each sub project is an independent project. Is there any relevant guidance on how docs gen generates the final document?
Pekko samples guide users on how to use Pekko, but is there a lack of guidance in Pekko samples?

GitHub link: https://github.com/apache/incubator-pekko-samples/discussions/91

----
This is an automatically sent email for notifications@pekko.apache.org.
To unsubscribe, please send an email to: notifications-unsubscribe@pekko.apache.org


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