Add documentation on transpiler plugins

[kevinsung]

Fixes #102 .

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[mtreinish]

From a quick read over the content it looks good. Just a few inline comments/suggestions.

[frankharkins]

This is really nice, thanks! I followed this successfully and I understand how I'd modify the examples with my own custom code.

I just have a couple of suggestions to smooth over the user experience.

[nbronn]

This looks pretty great! I just wanted to include more specific examples in cases mostly, somewhat in anticipation of how users will consume this.

[kevinsung]

@nbronn please take another look

[nbronn]

LGTM

[javabster]

Really nice intro! Very clear and celebrates the open-source community 👏

[javabster]

We edit the pyproject.toml, setup.cfg, or setup.py file of our package

I'm a bit confused about this section. How does a user know which file they should update? Does it depend on what type of plugin they're developing? Whatever the reason I think it would be good to highlight how a user decides which to update

[javabster]

Of course, your own plugin will do something more interesting than that.

Lol such sass I love it

[javabster]

Let's create our UnitarySynthesisPlugin subclass

For the code snippet following this line can you add some code comments briefly explaining each property?

[javabster]

Could you please add a "next steps" section to the end of the file? every docs page should have a next steps that includes at least one link to the learning platform

[javabster]

question: do you think we should split these 3 examples up into separate pages? The page feels quite long and I wonder if it would be more digestible if split up 🤔

[kevinsung]

I'm a bit confused about this section. How does a user know which file they should update? Does it depend on what type of plugin they're developing? Whatever the reason I think it would be good to highlight how a user decides which to update

pyproject.toml, setup.cfg, or setup.py are three different formats for storing the metadata for a Python project. Typically the creator of the package chooses only one of these formats, so there wouldn't be any confusion as to which file to edit (because only one of them exists). I've added a parentheses nothing this fact.

For the code snippet following this line can you add some code comments briefly explaining each property?

Done.

Could you please add a "next steps" section to the end of the file? every docs page should have a next steps that includes at least one link to the learning platform

Do you actually mean learning platform, or just the IQP platform in general (including documentation)? In any case, I couldn't think of an appropriate next step on these platforms, but I did add a next step for contributing the plugin to the Qiskit Ecosystem. Do you have any other specific pages in mind?

question: do you think we should split these 3 examples up into separate pages? The page feels quite long and I wonder if it would be more digestible if split up 🤔

I actually think it's better to have them all on one page. The right sidebar has the table of contents which makes the page easier to navigate.

[javabster]

Do you actually mean learning platform,

Yes I actually mean learning platform. In general we need to be more closely linking these 2 platforms so one of our goals is to have every docs page link to learning and vice versa. There might not be a specific page that fits perfectly for this but anything you think generally might be useful and focused around the theme of transpiling is fine

[kevinsung]

I've added generic links to the learning platform tutorials.

[javabster]

LGTM 🚀