Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

It's hard to contribute to the docs #237

Open
kettanaito opened this issue Oct 24, 2019 · 0 comments
Open

It's hard to contribute to the docs #237

kettanaito opened this issue Oct 24, 2019 · 0 comments
Labels
docs DX This issue improves developer's experience

Comments

@kettanaito
Copy link
Owner

What:

If I am a contributor and decide to improve the documentation I cannot do it unless I have an access into Atomic Layout's GitBook organization.

Why:

Current documentation repository is an artifact of the deployed documentation on GitBook. Since the current GitBook is a paid SaaS, as opposite to its previous OSS version, you cannot compile the documentation repository on your machine. Old version compiler will throw on production-specific tags (which are invalid Markdown tags and are used in the paid version alone).

Expected behavior:

Contributing to everythings, which includes documentation, should be easy and smooth.

Suggestions

Long-term: migrate away from GitBook and deploy a custom documentation.
Short-term: Investigate if it's possible in any way to contribute to the docs with the current setup.

@kettanaito kettanaito added DX This issue improves developer's experience docs labels Oct 24, 2019
@ruhaise ruhaise mentioned this issue Jan 2, 2020
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs DX This issue improves developer's experience
Projects
None yet
Development

No branches or pull requests

1 participant