igniteui / igniteui-docfx Goto Github PK

Rename the repo to igniteui-docfx

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

Combine igx-checkbox, igx-switch and igx-radio into one topic.

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

Description

The page is not loaded every time, Ctrl + F5 refresh is needed. Maybe this is somehow related to the Iframe element which is loading the Samples links in DocFX project.

Steps to reproduce

Open Edge browser and load our official demos page:
https://www.infragistics.com/products/ignite-ui-angular/angular/components/tabbar.html

Result

No samples are loaded

Expected result

Samples should be loaded

Attachments

1. Go here:
   https://www.infragistics.com/products/ignite-ui-angular/angular/components/date_picker.html
2. Observe the Inputs API table.

Actual Result: "todayBottonLabel"
Expected Result: "todayButtonLabel"

1. Go here:
   https://www.infragistics.com/products/ignite-ui-angular/angular/components/scrollbar.html
2. Observe the description for visibleItemsCount in the API table.

Actual result:
The total amount of items in that will be virtualized.

Expected result:
I don't know. Something like "The total number of items that are visible." I assume that's what it actually does based on the name, but I don't know if the implementation matches the name.

Is it possible that the descriptions for the totalItemsCount and visibleItemsCount inputs are switched? If so, I would recommend something like "The total number of items in the items source" and "The total number of visible items".

1. Go here:
   https://www.infragistics.com/products/ignite-ui-angular/angular/components/slider.html
2. Check the upperBound API description.

Actual result:
The lower boundary of the slider value. If not set is the same as min value.

Expected result:
The upper boundary of the slider value. If not set is the same as max value.

Since we are integrating StackBlitz in our documentation, we need a button for live sample editing. When clicked, it would lead to StackBlitz.

Add a demo and code example of how to make the grid columns responsive, meaning to hide some of them on small screens and show them on larger screens.

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

1. Go here:
   https://www.infragistics.com/products/ignite-ui-angular/angular/components/tabbar.html
2. Observe images in the running sample on the left.

Actual result:
The images are all broken.

Expected result:
They should appear.

Combine igxLabel and igxInput into one topic.

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

1. Go here:
   https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid.html
2. Observe the rank column.

Actual result:
The images are broken

Expected result:
The images appear

Trying to build and run the project with npm start results in a UnauthorizedAccessException being thrown with the following stack trace:

Error:System.UnauthorizedAccessException: Access to the path 'C:\ProgramData\chocolatey\lib\docfx\tools\plugins_kc5k4jjw.gij\plugins' is denied.
   at System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)
   at System.IO.Directory.InternalCreateDirectory(String fullPath, String path, Object dirSecurityObj, Boolean checkHost)
   at System.IO.Directory.InternalCreateDirectoryHelper(String path, Boolean checkHost)
   at Microsoft.DocAsCode.Build.Engine.TemplateManager.Copy(Action`1 streamHandler, String filePath, Boolean overwrite)
   at Microsoft.DocAsCode.Build.Engine.TemplateManager.TryExportResourceFiles(IEnumerable`1 resourceNames, String outputDirectory, Boolean overwrite, String regexFilter)
   at Microsoft.DocAsCode.SubCommands.BuildCommand.BuildDocument(String baseDirectory, String outputDirectory)
   at Microsoft.DocAsCode.SubCommands.BuildCommand.Exec(SubCommandRunningContext context)
   at Microsoft.DocAsCode.Program.ExecSubCommand(String[] args)

bs-docs-sidebar - Copy Code

When Copy Code is selected there is no indication that an action has been performed.

Expected result

Selecting the Copy Code updates the label to Copied (or any other indication that is appropriate)

Attachments

anchorjs-link doesn't work, on any of the links in the IgniteUI for Angular Samples Browser.

URL: https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid.html
Screenshot: https://i.imgur.com/KonqIft.png

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

Description

Anchor on h4 pre-scrolls inefficiently few rows and is not part of the navigation.

Steps to reproduce

Remove anchojs on h4.

Screenshot: https://i.imgur.com/WRtK7nO.png

bs-docs-sidebar - URL update in the address bar

Selecting an anchor in article updates the URL and the corresponding sidebar menu item. However selecting item from the side bar updates just the article leaving the previously selected URL in the address bar.

Expected result

Selecting an item from the sidebar Item updates the URL and the article.

Attachments

Description
Badge won't use position property any more and position has to be set via CSS.

Result
Till now, the position input was used to set the badge position.

Expected result
Position property should be removed from the topic and code snippets should be changed. Position should be removed from API summary as well.

1. Go here:
   https://www.infragistics.com/products/ignite-ui-angular/angular/components/slider.html
2. Check the description for value.

Actual result:
By default if no value is set the default value is same as lower upper bound.

Expected result:
I don't know. What is the default value? Is it the lower bound, the upper bound, or some average? I assume this is simply one number, not two?

Create topic for Toggle Directive

Research the structure that we would need in order to accommodate for a JP version of the component site for Ignite UI for Angular.

Once the structure is defined, copy the EN markdowns into the JP location and assign to the localization team for translation.

1. Go to any page on staging.
2. Check the right side for "IN THIS ARTICLE:".
3. Hover over a code snippet and check for the "COPY" text.

Actual result: None of these appear. They are all blank.

Expected result: The text from the shell appears.

1. Go here:
   https://www.infragistics.com/products/ignite-ui-angular/angular/components/slider.html
2. Check the type API description.

Actual result:
The duration visibility of thumbs labels. The default value is 750 milliseconds.

Expected result:
The type of the slider? Give some more information here?

The JS Blocks repository has now been renamed according to our blog post:
https://www.infragistics.com/community/blogs/b/infragistics/posts/ignite-ui-github-repo-name-changes

All references to igniteui-js-blocks should be replaced with igniteui-angular

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

1. Go here:
   https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid.html
2. Search for "catchError operator".

Actual Result:
"catchError operator which intercepts and Observable that failed"
Expected Result:
"catchError operator which intercepts an Observable that failed"

Currently on each topic we have a similar sample URL:

<iframe src='https://www.infragistics.com/angular-demos/avatar' width="100%" height="100%" seamless frameBorder="0"></inframe>

For staging we should have https://staging.infragistics.local instead of https://www.infragistics.com. It should be customizable for development environment .

In order to release the Angular documentation for 18.1, we need the header and footer of the site to be internationalized.

The website header and footer seem to be hardcoded instead of being pulled from the staging or live sites. What was the rationale behind this decision?
https://github.com/IgniteUI/igniteui-docfx/tree/d3f6f66825ddf3d266be4b195dce965b0fb90868/templates/ignite-ui-template/partials

If possible, can the header and footer pull content from the live or staging websites so that we don't duplicate content as hardcoded files? This is how it's done in the Ignite UI for JavaScript samples.

https://www.infragistics.com/products/ignite-ui-angular/angular/components/calendar.html
In the table, some of the types have backslashes in them. Is that correct?
Ex. Number \| WEEKDAYS
Is the intention that it's "Number or WEEKDAYS"? In that case, remove the \ because it's already escaped in the backticks.

Date \| Date[]
date: Date \| Date[]

Create an example on how to bind the igx-grid to a remote service, and how to perform filtering, sorting and paging operations on the back-end.

The Getting Started section of the README should be updated to reflect the need to run with elevated permissions on Windows.

Related issue

When you have an URL to a sample, for example "https://{environment:demosBaseUrl}/grid", you should be able to change the protocol, too. So please add the protocol in the demoBaseUrl itself. The aforementioned sample should be like this "{environment:demosBaseUrl}/grid". The reason for this is we don't need https for development purposes, only for staging and production, so we should have an option of changing the protocol.

bs-docs-sidebar - View zoom/resize issue

If the browser view is or has been zoomed in/out, the sidebar shows the previous item as selected instead of the actual selected one.

Discussed the same issues with resizing the browser view, however currently I cannot reproduce them.

Expected result

Sidebar will highlight as active the selected item, not the previous one.

Attachments

I only know a few off hand, while some are correct. There are a number that are wrong:
The United Kingdom has the USA flag
USA has the Uruguay flag
UAE has the USA flag
Tanzania has Thailand flag

In order to release the Angular documentation for 18.1, we need the viewer shell to be internationalized.

I see the viewer strings here.
https://github.com/IgniteUI/igniteui-docfx/blob/d3f6f66825ddf3d266be4b195dce965b0fb90868/templates/ignite-ui-template/styles/docfx.js

Can we make them localizable without maintaining copies of the scripts? We want to ensure that the sites have the same functionality.

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

Create functionallity that will allow plnkr editing and html/sample preview for angular demos page:
https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid.html

1. Go here:
   https://www.infragistics.com/products/ignite-ui-angular/angular/components/toast.html
2. Observe the last paragraph.

Actual result:
You can handle the onShown event by using (onShowing)="someFunc($event)".

Expected result:
You can handle the onShown event by using (onShown)="someFunc($event)".

https://www.infragistics.com/products/ignite-ui-angular/angular/components/list.html

The warning about Hammer.js below the demo is non-sequitur. It doesn't pertain directly to this control, and is therefore confusing to have here. If we want this warning, we should have it on the 'getting started with IgniteUI for Angular' page: https://www.infragistics.com/products/ignite-ui-angular/getting-started

Description
Side Navigation Menu is missing in Internet Explorer

Steps to reproduce

1. Open following link https://www.infragistics.com/products/ignite-ui-angular/angular/components/button.html in Internet Explorer

Result
Side Navigation Menu does not show up.

Expected result
Side Navigation Menu must be rendered.

Attachments

Description

When opening a doc page with a sample, the loading SVG appears to be hanging.

Steps to reproduce

1. Open the grid page

Result

The loading SVG does not spin.

Expected result

The loading SVG should be spinning.

Attachments

https://github.com/IgniteUI/igniteui-docfx/blob/master/en/components/navdrawer.md
Look at the description of the pinned property.
"Currently only support." This makes no sense. What does it currently support? Is it unsupported?

The initialization code should be updated to reflect the changes introduced in 5.1.0 and onwards.

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

Article guidance - https://github.com/IgniteUI/igniteui-docfx/blob/master/.github/CONTRIBUTING.md

bs-docs-sidebar - UI improvements

H5 active and on hover look almost the same.

Steps to reproduce

1. Remove block element on hover.

Result

On hover the block will not appear.

Expected result

onHover and active interaction will be easily differentiated.

Attachments