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

Added HTML tables to documentation page to improve UX. #514

Merged
merged 1 commit into from
Apr 14, 2018
Merged

Added HTML tables to documentation page to improve UX. #514

merged 1 commit into from
Apr 14, 2018

Conversation

InternetExplorer7
Copy link
Contributor

@InternetExplorer7 InternetExplorer7 commented Mar 19, 2018

Motivation

To create a patch to help resolve this change request: #436

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Tested by re-running server to confirm page is still rendered properly and that the page is still being correctly served. I then ran 'yarn test' and that passed all test cases.

Related PRs

#508

Tests

All Yarn tests passed locally up to most recent commit

Change Impact Analysis

screen shot 2018-03-18 at 8 57 12 pm

For #436, only Markdown code was changed to support HTML5 table elements, and some basic CSS3 styling. No other components were modified or changed.

Do any existing requirements in the baseline conflict with the proposed change?
No.

Do any other pending requirements changes conflict with the proposed change?
No.

What are the business or technical consequences of not making a change?
A less ideal UX (user experience).

Will the proposed change adversely affect performance requirements or other quality attributes?
No, for this change there will be 0 impact to performance requirements. Quality of code remains the same.

Is the proposed change feasible within known technical constraints and current staff skills?
Yes.

Will the proposed change place unacceptable demands on any computer resources required for the development, test, or operating environments?
No, computer resources should stay the same.

Must any tools be acquired to implement and test the change?
Contributors may use the built-in test suite to test the change using command yarn test

How will the proposed change affect the sequence, dependencies, effort, or duration of any tasks currently in the project plan?
No dependencies needed to be changed and no new dependencies needed to be added in order to implement this change.

Will prototyping or other use input be required to verify the proposed change?
Yes, the user may request the page that's been modified /en/docs/... and check that the changes have been rendered correctly.

How much effort that has already been invested in the project will be lost if this change is accepted?
Maybe an hour.

Will the proposed change cause an increase in product unit cost, such as by increasing third-party product licensing fees?
No.

Will the change affect any marketing, manufacturing, training, or customer support plans?
No.

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 19, 2018
@InternetExplorer7 InternetExplorer7 changed the title Added support for html5 tables and CSS3 styles. Added HTML tables to documentation page to improve UX. Mar 19, 2018
This was referenced Mar 19, 2018
@yangshun yangshun merged commit a9f8701 into facebook:master Apr 14, 2018
@yangshun
Copy link
Contributor

Thanks @InternetExplorer7 ! I changed the HTML to Markdown and added custom styles so that we don't have to write inline-styles in the code. Looking forward to more contributions from you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants