-
Notifications
You must be signed in to change notification settings - Fork 135
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
RDoc-2342 Indexes > Create & Deploy Indexes [Fix article] #1962
RDoc-2342 Indexes > Create & Deploy Indexes [Fix article] #1962
Conversation
…s to the 5.4 folder
d08e26c
to
6f8d282
Compare
{NOTE: } | ||
|
||
##### Static-indexes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's an extensive usage of notes as content frames throughout the article and PR,
Please don't use them for this purpose, to prevent the numerous notes from blurring and cluttering the page and so real notes will be recognized as such when they are needed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Usage is as needed
The resulting output is very clear
it is not blurring or cluttering
the opposite - everything is well-organized and clear for the reader
The previous version of the "Create & Deploy Indexes" article was poorly written.
it didn't provide a comprehensive and well-detailed guide for creating indexes.
Content was duplicated, disorganized, and used imprecise terminology.
Overload examples and some content were missing.
Overall, it was confusing and difficult to follow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use the regular documentation articles structure,
without the extensive usage of notes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some modifications were made - see the latest
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
perfect
the content-frame
segments are exactly right
Related issues:
https://issues.hibernatingrhinos.com/issue/RDoc-3148/Indexes-What-are-Indexes-Fix-articles
https://issues.hibernatingrhinos.com/issue/RDoc-2342/Indexes-Create-Deploy-Indexes-Fix-article
https://issues.hibernatingrhinos.com/issue/RDoc-2348/Auto-index-creation-condition
https://issues.hibernatingrhinos.com/issue/RDoc-3145/C-Indexes-Create-Deploy-Indexes-Fix-article
https://issues.hibernatingrhinos.com/issue/RDoc-3146/Node.js-Indexes-Create-Deploy-Indexes-Fix-article
C# - @aviv86 - files to review:
"Indexes Overview" article:
Documentation/5.2/Raven.Documentation.Pages/studio/database/Indexes/indexes-overview.markdown
"Studio configuration" article:
Documentation/5.3/Raven.Documentation.Pages/studio/database/settings/studio-configuration.markdown
"Put indexes" article:
Documentation/5.4/Raven.Documentation.Pages/client-api/operations/maintenance/indexes/put-indexes.dotnet.markdown
"Create and Deploy" article:
Documentation/5.4/Raven.Documentation.Pages/indexes/creating-and-deploying.dotnet.markdown
Documentation/5.4/Samples/csharp/Raven.Documentation.Samples/Indexes/Creating.cs
"What are indexes" article:
Documentation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.dotnet.markdown
Documentation/5.4/Samples/csharp/Raven.Documentation.Samples/Indexes/WhatAreIndexes.cs
*Node.js - @ml054 - files to review:
"Put indexes" article:
Documentation/5.4/Raven.Documentation.Pages/client-api/operations/maintenance/indexes/put-indexes.js.markdown
"Create and Deploy" article:
Documentation/5.4/Raven.Documentation.Pages/indexes/creating-and-deploying.js.markdown
Documentation/5.4/Samples/nodejs/indexes/creating.js
"What are indexes" article:
Documentation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.js.markdown
Documentation/5.4/Samples/nodejs/indexes/whatAreIndexes.js
Java files for article "Creating and Deploying Indexes" were only copied over so they will show.