Translating Semantic UI Docs

Gaining Access

If you do not have push/pull access to a translated repository, you can get started by forking the main Semantic repository. Once you gain access to the proper repository, you can push your forked repository to a new remote url (the semantic-org translation repository)

Getting Set-up

After cloning the repository you will need to clone your language's repository.

For help doing this see this article

All localizable documents exist in server/documents/, additionally the README for the repository can be translated.

You can immediately begin by opening these documents and directly translating the examples.

Seeing Changes As You Edit

To view edits in the documentation as you are changing files. See the guide to setting up local documentation

You might also need to run grunt build once after setting up the server. This will create a version of semantic inside the documentation folder docs/ that is accessible to your doc server.

Deploying your code online

When deploying code be sure your CNAME file located at server/files/CNAME refers to the domain xx.semantic-ui.com where xx is your language code, for example it.semantic-ui.com. You will also need to contact an administrator to make sure the DNS records are set up for your subdomain.

You can deploy your translations online from the command line once everything is set-up using the docpage ghpages plugin

docpad deploy-ghpages --env static

The documentation should then be accessible on the web at xx.semantic-ui.com

Linking to Semantic Packages

It is suggested to link directly to the latest package of Semantic at the main domain, for all download links inside your project http://www.semantic-ui.com/build/semantic.zip. This way updates to Semantic will not be dependent on you updating your repository.

You may want to remove the version number from the homepage of your documentation to avoid having to update it as changes to the version number of semantic are made.

Getting Upstream Changes

As the semantic documentation is updated in the english translation, you may want to update your translation to match. An easy way to manage upstream changes is to add an additional remote server and keep your fork up to date using this guide by Github

Finishing Up

Once you have your translation to a point where you believe it is ready for other eyes to see, contact an administrator so they can add links to your translation project from the main repository.