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

Jump to bottom

Issue 7624: New Documentation #7626

Merged
merged 342 commits into from Jul 8, 2021
Merged

Issue 7624: New Documentation #7626

merged 342 commits into from Jul 8, 2021

Conversation

Siemienik
Copy link
Contributor

@Siemienik Siemienik commented Mar 11, 2021 •
edited by krzysztofspilka

Context

We want to provide a better experience to users working with Handsontable documentation at handsontable.com/docs.

How has this been tested?

  • Textual content was reviewed by the Customer Success Team
  • Layout was designed and approved by @krzysztofspilka
  • I launched stage deployment, which all affected persons might review.

Types of changes

  • New feature or improvement (non-breaking change which adds functionality)

Related issue(s):

Do not forget during the review:

  • Check if plugins options are correctly associated
  • Remove redundant (temporarily added versions)

@Siemienik
Add 'docs/' from commit '5427b5d35d8913e8356a9b3e0c07829cc84b79a4'
2be4215 
git-subtree-dir: docs
git-subtree-mainline: b36b47b
git-subtree-split: 5427b5d
@codesandbox-ci
Copy link

codesandbox-ci bot commented Mar 11, 2021 •
edited

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit bbf77c7:

Sandbox Source
vanilla-handsontable-pr Configuration

@Siemienik
Added sitemap.xml (https://github.com/handsontable/docs-md/pull/105)
ee5bb79 
* Added sitemap.xml

* deploy on develop

resolves: https://github.com/handsontable/docs-md/issues/93
@Siemienik
Merge branch 'feature/docs-next/jsdoc-update' into feature/issue-7624
b9b00ef
@Siemienik
Readme update (https://github.com/handsontable/docs-md/pull/106)
2befad8 
* Splitting README.md

* Update readmes

* Block publishing README_EDITING and README_DEPLOYMENT

resolves: https://github.com/handsontable/docs-md/issues/102
@Siemienik
API Fixaxtions
230e552 
ref: https://github.com/handsontable/docs-md/issues/11
@Siemienik
API Fixations
ecc13b9 
ref: https://github.com/handsontable/docs-md/issues/11
@Siemienik
API Fixations
f5a25be 
ref: https://github.com/handsontable/docs-md/issues/11
@Siemienik
API Fixations
6bbd4ce 
ref: https://github.com/handsontable/docs-md/issues/11
@Siemienik
Merge commit '6bbd4cef1f669793333ee1b8ead78a3d12751fdc' into feature/…
0f6a76d 
…issue-7624
@Siemienik
FIX Deployment
400ccae
@Siemienik
FIX Deployment, change image name, limit to path,
2c87620
@Siemienik
run Documentation deployment
badde04
@Siemienik
Use local Handsontable version for non production build mode.
99dd3b1 
Typo fix
Added Docker ignore file

resolves: https://github.com/handsontable/docs-md/issues/16
@Siemienik
Fixations from slack thread
c30469b
@Siemienik
Regenerate API Reference
fbc43e3
Siemienik
Siemienik commented Mar 19, 2021
View reviewed changes
Copy link
Contributor Author

@Siemienik Siemienik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did self review, many minor comments I added.

.github/workflows/documentation.yml Outdated Show resolved Hide resolved
docs/.vuepress/config.js Outdated Show resolved Hide resolved
docs/.vuepress/config.js Show resolved Hide resolved
docs/.vuepress/examples.js Outdated Show resolved Hide resolved
docs/.vuepress/public/scripts/handsontable-manager.js Outdated Show resolved Hide resolved
docs/package.json Outdated Show resolved Hide resolved
src/plugins/autoColumnSize/autoColumnSize.js Outdated Show resolved Hide resolved
src/plugins/manualRowMove/manualRowMove.js Outdated Show resolved Hide resolved
src/plugins/manualColumnMove/manualColumnMove.js Outdated Show resolved Hide resolved
src/plugins/columnSummary/columnSummary.js Outdated Show resolved Hide resolved
@Siemienik Siemienik marked this pull request as ready for review March 19, 2021 14:27
@Siemienik Siemienik requested a review from aninde March 19, 2021 14:31
@krzysztofspilka krzysztofspilka self-requested a review March 20, 2021 20:16
@krzysztofspilka
Copy link
Member

krzysztofspilka commented Mar 20, 2021 •
edited by Siemienik

Hey, @Siemienik I will be testing this iteratively as some of these issues hold me back from conducting further tests. I expect we will have at least 4 stages here - 1. Fix most obvious issues, 2. Improve styles/formatting, 3. Conduct tests under various devices and environments, 4. Fix content.

Test iteration 1

  1. Search doesn’t work.

  2. Table of contents doesn’t show up on the 13’’ screen.

  3. Unnecessary badge “This is unreleased documentation for Handsontable Next version.” - please remove it.

  4. Most Handsontable instances don’t show up, like here https://dev.handsontable.com/docs/next/load-and-save because of this “(index):145 Uncaught SyntaxError: Unexpected token ‘)’” error

  5. H1 hides under the top navigation layer when accessed from an URL with an anchor https://dev.handsontable.com/docs/next/suspend-rendering/#frontmatter-title

  6. Errors are thrown occasionally

    1. https://dev.handsontable.com/docs/next/suspend-rendering/#frontmatter-title - 404
    2. https://dev.handsontable.com/docs/next/numeric/ - Error: The "destroy" method cannot be called because this Handsontable instance has been destroyed
    3. https://dev.handsontable.com/docs/next/data-binding/ - SyntaxError: Unexpected token ')'
    4. https://dev.handsontable.com/docs/next/migration-guide/#migrating-from-7-to-8 - 404s
    5. https://dev.handsontable.com/docs/next/modules/ - 404
    6. https://dev.handsontable.com/docs/next/cell-editor/ - https://dev.handsontable.com/docs/next/cell-editor/
    7. https://dev.handsontable.com/docs/next/moving/ - 404
    8. https://dev.handsontable.com/docs/next/read-only/ - VM196:19 Uncaught SyntaxError: Unexpected token ';'

  7. Dropdown values hide under the code field, eg. https://dev.handsontable.com/docs/next/dropdown/ (expand any cell)

  8. In the top menu element "Guide" should be renamed to “Guides” (plural)

Siemienik and others added 11 commits July 6, 2021 12:59
@Siemienik
Merge branch 'develop' into feature/issue-7624
0e0757c
@wszymanski
Separated containers on "Events and hooks" page to fix problem and ad…
991fa3e 
…ded margins (#8369)

* Separated containers to fix problem & added margins #8368

* Changes after CR #8368
@Osky772 @budnix
change warning box (#8343)
e785e5f 
Co-authored-by: budnix <571316+budnix@users.noreply.github.com>
@Siemienik
New Docs: FIX search shortcuts after route changed. (#8375)
72aac29 
* FIX search shortcuts after route changed.
resolves: #8374

* FIX to cover more situations.
@Siemienik
Add production workflow, manual run (#8382)
93d95ca
@budnix
Fix demos by adding height: 'auto' option to HoT (#8393)
edd6c10
@aninde
Tag improvements for Hello world app (#8387)
e88960b 
* Adds Opera to the table of supported browsers

* Adds 'demo' tag for Hello world app
@budnix
Improve markdown table's styling (#8376)
476e23f
@budnix
Fix demo and icon styles for dark theme (#8395)
659ab33
@budnix
Remove the "feature/issue-7624" branch from GA Workflow
588fc04
@Siemienik
Regenerate v9.0 files (#8396)
e25ad7b
@aninde
Create documentation template (#8184)
bbf77c7 
* Create documentation template

* Adjustment after review

* Delete unnecessary file

* Rename some templates

* Adjustment after review

* Rename label

* Revert order of templates

* Adjustment after review

* Reverte label name

* Make label lower case
aninde
aninde approved these changes Jul 8, 2021
View reviewed changes
Copy link
Contributor

@aninde aninde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 1

mrpiotr-dev
mrpiotr-dev approved these changes Jul 8, 2021
View reviewed changes
Copy link
Contributor

@mrpiotr-dev mrpiotr-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume we unnoticed some bugs etc., but in PRs like this one (the matter of a huge number of changed files/lines) - that happens. Please remember to move non-applied suggestions to post-release tasks. I don't see any blockers. I think we can merge docs to the develop branch and polish it in the next few days.

@budnix budnix merged commit f513f88 into develop Jul 8, 2021
@budnix budnix deleted the feature/issue-7624 branch July 8, 2021 11:10
This was referenced Jul 12, 2021
Closed
Closed
Closed
Closed
Siemienik added a commit that referenced this pull request Jul 15, 2021
@Siemienik
Revert the jsdoc linking workaround, fix jsdoc converter tool to gene…
ebf40e1 
…rate proper links.

ref: #7626 (comment)
ref: #7626 (comment)
@Siemienik Siemienik mentioned this pull request Jul 15, 2021
Merged
Siemienik added a commit that referenced this pull request Aug 4, 2021
@Siemienik
Documentation: cleanup jsdoc linking syntaxt - remove workaround (#8496)
85490c3 
* Revert the jsdoc linking workaround, fix jsdoc converter tool to generate proper links.
ref: #7626 (comment)
ref: #7626 (comment)

* Update links to jsdoc syntaxt

* Applying proper links syntaxt
ref: #8496 (review)

* Fix DragToScroll link
warpech added a commit that referenced this pull request Apr 29, 2022
@warpech
remove @vuepress/plugin-search
bb08895 
because it is not used in our VuePress installation (we have a custom search added in #7626)
@warpech warpech mentioned this pull request Apr 29, 2022
Closed
5 tasks
warpech added a commit that referenced this pull request Apr 29, 2022
@warpech
remove @vuepress/plugin-search
a353994 
because it is not used in our VuePress installation (we have a custom search added in #7626)
warpech added a commit that referenced this pull request May 6, 2022
@warpech
remove @vuepress/plugin-search (#9444)
c65ebf9 
because it is not used in our VuePress installation (we have a custom search added in #7626)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wszymanski wszymanski wszymanski left review comments

@budnix budnix budnix left review comments

@krzysztofspilka krzysztofspilka krzysztofspilka left review comments

@aninde aninde aninde approved these changes

@mrpiotr-dev mrpiotr-dev mrpiotr-dev approved these changes

@kirszenbaum kirszenbaum kirszenbaum approved these changes

@wojciechczerniak wojciechczerniak Awaiting requested review from wojciechczerniak

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create documentation based on markdown