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

TW changes, consolidated files, and fixed broken links #19

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jcayx
Copy link
Contributor

@jcayx jcayx commented May 16, 2023

  • made several changes as requested by TW
  • consolidated + removed /docs/howto/platform-sdk-quickstart-guide.md and /docs/references/platform-sdk.md
  • fixed any broken links resulting from the file consolidation

Copy link
Collaborator

@paul-england paul-england left a comment

Choose a reason for hiding this comment

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

Please make getting_started_markdown.md and differences_with_original_sdk.md kebab case and not snake case?

machine:

- Microsoft Windows 7 or Later (64-bit)
- Alteryx Designer Version 2021.2\*
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why the asterisk?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

here it indicates the note below the list with the asterisk is related to this line. Bit confusing imo but this information matches our other documentation

- [node](https://nodejs.org/en/download/) [14](https://nodejs.org/en/blog/release/v14.17.3/)
- [Git](https://git-scm.com/downloads)

\*Alteryx Designer version 2021.4 or greater is required to use the Alteryx Python
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why the asterisk?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

see above comment


1. Run this command to install the AYX Plugin CLI:\
\
`pip install ayx-plugin-cli`\
Copy link
Collaborator

Choose a reason for hiding this comment

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

These are already covered in Install at the top of the doc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed this section and included link to the earlier part of the doc

@jcayx
Copy link
Contributor Author

jcayx commented Jun 26, 2023

Please make getting_started_markdown.md and differences_with_original_sdk.md kebab case and not snake case?

changed all markdown and image files to kebab case, fixed any links using the old filenames too. Left the python files as snake case since that seems to be our standard

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

Successfully merging this pull request may close these issues.

2 participants