reactjs / ml.reactjs.org

(Work in progress) React documentation website in Malayalam

reactjs.org

This repo contains the source code and documentation powering reactjs.org.

Getting started

Prerequisites

1. Git
2. Node: any 12.x version starting with v12.0.0 or greater
3. Yarn: See Yarn website for installation instructions
4. A fork of the repo (for any contributions)
5. A clone of the reactjs.org repo on your local machine

Installation

1. cd reactjs.org to go into the project root
2. yarn to install the website's npm dependencies

Running locally

1. yarn dev to start the hot-reloading development server (powered by Gatsby)
2. open http://localhost:8000 to open the site in your favorite browser

Contributing

Guidelines

The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the contributing guidelines for the appropriate sections.

Create a branch

1. git checkout master from any folder in your local reactjs.org repository
2. git pull origin master to ensure you have the latest main code
3. git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

1. Follow the "Running locally" instructions
2. Save the files and check in the browser
3. Changes to React components in src will hot-reload
4. Changes to markdown files in content will hot-reload
5. If working with plugins, you may need to remove the .cache directory and restart the server

Test the change

1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
2. Run yarn check-all from the project root. (This will run Prettier, ESLint, and Flow.)

Push it

1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fix header logo on Android) to stage and commit your changes
2. git push my-fork-name the-name-of-my-branch
3. Go to the reactjs.org repo and you should see recently pushed branches.
4. Follow GitHub's instructions.
5. If possible, include screenshots of visual changes. A Netlify build will also be automatically created once you make your PR so other people can see your change.

Translation

If you are interested in translating reactjs.org, please see the current translation efforts at isreacttranslatedyet.com.

If your language does not have a translation and you would like to create one, please follow the instructions at reactjs.org Translations.

Troubleshooting

• yarn reset to clear the local cache

License

Content submitted to reactjs.org is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.

ml.reactjs.org's Issues

Unnecessry text and color in home page

There is unnecessary text in ഒരിക്കല്‍ പഠിക്കൂ, എവിടെ വേണമെങ്കിലും എഴുതൂ portion and yellow color in the left-middle portion of ml.reactjs homepage

Malayalam Translation Progress

Maintainer list

• @shahulhameed00
• @stultus

For New Translators

To translate a page:

1. Check that no one else has claimed your page in the checklist and comments below.
2. Comment below with the name of the page you would like to translate. Take only one page at a time.
3. Clone this repo, translate your page, and submit a pull request!

Before contributing, read the glossary and style guide (once they exist) to understand how to translate various technical and React-specific terms.

Please be prompt with your translations! If you find find that you can't commit any more, let the maintainers know so they can assign the page to someone else.

For maintainers

When someone volunteers, edit this issue with the username of the volunteer, and with the PR. Ex:

• Home Page (@tesseralis) #10

When PRs are merged, make sure to mark that page as completed!

Core Pages

To do before releasing as an "official" translation. Please translate these pages first.

• Home Page (@shahulhameed00) #10
• Tutorial

Basics

• Hello World (@boywithsilverwings )
• Introducing JSX (@farzanfa)
• Rendering Elements (@robintom)
• Components and Props
• State and Lifecycle
• Handling Events (@vineeth-nair)
• Conditional Rendering
• Lists and Keys
• Forms (@jomonthomaslobo )
• Lifting State Up
• Composition vs Inheritance
• Thinking in React

API Reference

• React
• React.Component
• ReactDOM
• ReactDOMServer
• DOM Elements
• SyntheticEvent
• Test Utilities
• Shallow Renderer
• Test Renderer
• JS Environment Requirements
• Glossary

Navigation

These are the navigation links that appears in the sidebar. Possibly wait until
the corresponding sections are translated to do these.

• tutorial/nav.yml
• docs/nav.yml

Next Steps

These are the next most important translations, ordered by importance:

Installation

• Getting Started (@kurianbenoy)
• Add React to a Website
• Create a New React App
• CDN Links

Hooks

Everyone is hooked on hooks! People are really excited for these and it would be great for them to be translated.

• Introducing Hooks (@boywithsilverwings)
• Hooks at a Glance (@boywithsilverwings)
• Using the State Hook
• Using the Effect Hook
• Rules of Hooks
• Building Your Own Hooks
• Hooks API Reference
• Hooks FAQ

Warnings

These are the pages that you get when you click the links in the console (e.g. https://reactjs.org/warnings/dont-call-proptypes.html). People tend to search these, so please don't translate the error message itself.

• dont-call-proptypes
• invalid-aria-prop
• invalid-hook-call-warning
• legacy-factories
• refs-must-have-owner
• special-props
• unknown-prop

Advanced Guides

• Accessibility
• Code-Splitting
• Context
• Error Boundaries
• Forwarding Refs
• Fragments
• Higher-Order Components
• Integrating with Other Libraries
• JSX In Depth
• Optimizing Performance
• Portals
• React Without ES6
• React Without JSX
• Reconciliation
• Refs and the DOM
• Render Props
• Static Type Checking
• Strict Mode
• Typechecking With PropTypes
• Uncontrolled Components
• Web Components

FAQ

• APIs and AJAX
• Babel, JSX, and Build Steps
• Passing Functions to Components
• Component State
• Styling and CSS
• File Structure
• Versioning Policy
• Virtual DOM and Internals

Contributing

Priority: Low

• How to Contribute
• Codebase Overview
• Implementation Notes
• Design Principles

Components

Components in src/components that have some text in them.

• CodeEditor
• CodeExample
• ErrorDecoder
• LayoutFooter
• LayoutHeader
• MarkdownPage

Additional Translations

These are not the primary translation targets.

• Blog
• Community

Unnecessary text and different header size used

In the file ml.reactjs.org/content/docs/hooks-intro.md there is unnecessary text in the കുറിപ്പ് section. The text was needed to remove when clearing the conflicts.

Also the font size used for the description of ദൃശ്യം {#video-introduction} section is not correct. Font size of the description is same as the heading. It should be lesser than heading.

Translating Glossary

Here are some suggestions for the translation of terms commonly used in this type of technical documentation.

Original word/term	Suggestion
arrow function	arrow ഫങ്ഷൻ
bug	ബഗ്
camelCase	കാമല്‍കേസ്
callback	കോള്‍ബായ്ക്ക്
controlled component	നിയന്ത്രിത കമ്പോണന്റ്
debugging	‍ഡിബഗ്ഗിംഗ്
framework	ഫ്രേംവര്‍ക്ക്
function component	ഫങ്ക്ഷന്‍ കംമ്പോണന്റ്
hook	ഹുക്ക്
key	കീ
lazy initialization	ലേസി ഇനിയിഷ്യലൈസേഷന്‍
library	ലൈബ്രറി
lowercase	ലോവര്‍കേസ്
React element	React എലമെന്റ്
render	റെന്റര്‍
template literals	ടെമ്പ്ലേറ്റ് ലിറ്ററല്‍സ്
uncontrolled component	അനിയന്ത്രിത കംമ്പോണന്റ്

No translation required
array
bundle
class
constructor
context
Create React App
DOM
fragments
HTML
XML
MDN
Tick
package
props
portal
ref
React
React Native
strings
state
Web（Encounter capitalized Web, don't translate）
widgets
UI
key

Unnecessry text and color in docs/getting-started.html page

Unnecessary text that forgot to remove when fixing merge conflicts is appeared in docs/getting-started.html page. Also checksum of the merge conflict is appearing in specified page.

Problems are appeared in the portions of ഓൺലൈൻ പ്ലേ ഗ്രൗണ്ട് and പ്രാക്ടിക്കൽ ട്യൂട്ടോറിയൽ