isolate the module and docs

[maddhruv]

The concern I want to raise here is about isolating the module/script that we use for collecting the node versions docs and the translated docs into two different branches

• master branch - docs (en + translated)
• module branch - module (i18n) and scripts

Why?

It is very difficult to clone/pull all these translated file/docs every time, which is an unnecessary flow if one wants to write some scripts/module

[maddhruv]

/cc @zeke @amorist @lukaszewczak

[amorist]

If we want to release the npm module or write script, may need docs content.

https://github.com/electron/i18n/blob/master/lib/apis.js

[maddhruv]

but even if we are to publish the module, will we be publishing all the content as well?

[amorist]

just json file

[amorist]

or load content from master branch (master branch - docs (en + translated))

[maddhruv]

the problem that shall persist is about cloning the whole repo with translated content every time?

[amorist]

#133

https://github.com/nodejs/i18n/pull/133/files#diff-c1465faaf602bd4f13f4f0b666cb9eed

const contentDir = path.join(__dirname, '../content')

[zeke]

It is very difficult to clone/pull all these translated file/docs every time

@maddhruv can you describe in more detail what is difficult about this process?

[maddhruv]

Whenever I clone or fetch the repo
There are thousands of files - translated docs
Which need to be fetched

[zeke]

Yes there are many files, but that is the nature of a project like this. I don't see how breaking things up into separate branches would solve the problem, as the code that builds the module will need to access all the content, and you can't be on two branches at once. They should live together.

The module content that gets published to npm, however, is a different story. The published npm module will need to be able to access the content in some structured format like JSON or LevelDB, but the original markdown files and the JavaScript code used to build the module can be omitted from the npm package using and .npmignore file.

[maddhruv]

can't we do both the things separate as

• translated docs is a separate module
• translate script/module is separate
  ?

[alexandrtovmach]

It's not an issue anymore, because we're using Crowdin. Should be closed