readthedocs / actions

GitHub Actions for Read the Docs
MIT License
33 stars 10 forks source link

Simultaneous support of multiple languages #25

Open Yaminyam opened 1 year ago

Yaminyam commented 1 year ago

Can't support multiple language previews at once? I think it would be nice to receive multiple arguments from the project language so that multiple links can be inserted.

humitos commented 1 year ago

Thanks for opening this issue. Can you please expand on the use case here and how you are particularly using this action?

Yaminyam commented 1 year ago

https://github.com/lablup/backend.ai/pull/1130 Our repo uses both en and kr docs at the same time.

project-language: |
    "en"
    "ko"

Currently, we are running two jobs to insert preview links each, but it would be nice to be able to insert multiple language links into one paragraph with one job, as in the example above. Running the job twice creates two paragraphs in the current workflow.

Yaminyam commented 1 year ago

And, especially when you want to insert project preview links with the same slug but different languages, if you run multiple jobs, the links from the later jobs will overwrite the existing links. So in the above link I am using "sorna-ko" slug not "sorna".

humitos commented 1 year ago

I understand. Thanks for expanding on this use case.

We have a similar workflow in our own project. We also run the same action twice (it's a mono-repo with multiple Read the Docs projects) and we are changing the message-template to list them in a more nice way. Take a look at this example: Screenshot_2023-03-07_10-51-39

I think what you are suggesting is a good idea and should be implemented at some point.