Comments (4)
I think that is a good way to proceed.
from groonga.
Is there a purpose of having the same structure as this document and splitting the common parts?
If so, why not start by making contribution/documentation/introduction.rst
the same structure, instead of splitting it up first?
It seems to me that this would make it easier to check common parts.
from groonga.
@abetomo
Thanks. I agree with your opinion because in this moment we are not sure splitting this document is better way.
I will update the current document and then think of the next step. How do you think of the following idea? If you agree with me, I will change the title and content of this issue.
doc: add steps for updating documentation to document contribution page
What is your problem?
As a new contributor, I find it challenging to understand the process for contributing updates to the Groonga documentation. It would be helpful for them to add following steps to introduction.rst
.
- Editing the documentation
- Previewing changes
- Submitting changes
My suggestions
I propose to add a new sections to the introduction.rst
about the documentation update process.
- Edit Documentation Sources
- Reflect Your Modifications
- Preview Your Modifications on HTML
- Update Translations
- Reflect Your Translations
- Preview Your Translations on HTML
- Send Pull Request to Groonga Repository
Next Steps after this issue
The content will be similar a little bit to the I18N page, but with a new flow.
We'll think about combining them after updating this introduction.rst
.
from groonga.
Thanks! I've just updated the issue.
from groonga.
Related Issues (20)
- docs: Generate C API documentation with Doxygen HOT 3
- Add support for HNSW
- Sequential search not working when specifying multiple columns with `match_columns`
- Upload wrong link to packages for Windows HOT 1
- Remove deprecated CentOS content to avoid misleading users HOT 2
- Distribute the install packages which enabled libedit
- Add Amazon Linux 2023 support
- [Document] `sed: /usr/local/etc/mecabrc: No such file or directory` HOT 3
- [Document] Difference in TokenFilterStem descriptions
- ci package ubuntu: add test for Ubuntu focal HOT 49
- ci packages: reduce matrix defintions
- ci package: add timeout to build step HOT 3
- Drop support for i386 architecture HOT 6
- ci package: reduce execution time about especially arm64 HOT 1
- Exact match searches not working with `TABLE_HASH_KEY`
- Groonga 14.0.7 HOT 12
- ci package: Docker cache isn't working during build step
- Add Unicode 16.0 based normalizer HOT 2
- Add TokenCharabia
- ci package ubuntu: automatically unify dependency packages
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from groonga.