Skip to content

Commit afa0c89

Browse files
committedMay 1, 2021
Corrected documentation for release 0.8.5.2
1 parent b497093 commit afa0c89

13 files changed

+258
-145
lines changed
 

‎README.md

+94-74
Large diffs are not rendered by default.

‎docs/.doctrees/about_ydk.doctree

0 Bytes
Binary file not shown.

‎docs/.doctrees/environment.pickle

1.01 KB
Binary file not shown.

‎docs/.doctrees/faq.doctree

-185 Bytes
Binary file not shown.
7.05 KB
Binary file not shown.

‎docs/about_ydk.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h2>Version<a class="headerlink" href="#version" title="Permalink to this headli
157157
<p>To check out the version of ydk-gen used to generate this ydk-py, use the below commands:</p>
158158
<div class="highlight-bash"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
159159
2</pre></div></td><td class="code"><div class="highlight"><pre><span></span>$ git clone https://github.com/ygorelik/ydk-gen.git
160-
$ git checkout 07b3eddabee65b731eb1171d273632cf7d3a656d
160+
$ git checkout b497093708fde29197a385c5d83d3ab40df26361
161161
</pre></div>
162162
</td></tr></table></div>
163163
</div>

‎docs/faq.html

+12-15
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,10 @@ <h2>How do I report a bug I found?<a class="headerlink" href="#how-do-i-report-a
148148
</div>
149149
<div class="section" id="i-am-interested-in-contributing-how-do-i-do-this">
150150
<h2>I am interested in contributing. How do I do this?<a class="headerlink" href="#i-am-interested-in-contributing-how-do-i-do-this" title="Permalink to this headline"></a></h2>
151-
<p>YDK is an open-source project and we welcome contributions. Please refer to this <a class="reference external" href="https://github.com/CiscoDevNet/ydk-gen/blob/master/CONTRIBUTIONS.md">brief guide</a>, make the changes on your fork of <a class="reference external" href="https://github.com/CiscoDevNet/ydk-gen">ydk-gen</a> and submit a pull request <a class="reference external" href="https://github.com/CiscoDevNet/ydk-gen/pulls">here</a>.</p>
151+
<p>YDK is an open-source project and we welcome contributions.
152+
Please refer to this <a class="reference external" href="https://github.com/CiscoDevNet/ydk-gen/blob/master/CONTRIBUTIONS.md">brief guide</a>,
153+
make the changes on your fork of <a class="reference external" href="https://github.com/CiscoDevNet/ydk-gen">ydk-gen</a> and submit a pull request
154+
<a class="reference external" href="https://github.com/CiscoDevNet/ydk-gen/pulls">here</a>.</p>
152155
</div>
153156
<div class="section" id="can-you-help-me-change-something-in-a-model-bundle-api">
154157
<h2>Can you help me change something in a model bundle API?<a class="headerlink" href="#can-you-help-me-change-something-in-a-model-bundle-api" title="Permalink to this headline"></a></h2>
@@ -169,38 +172,32 @@ <h2>What version of YDK core can be used with YDK bundles?<a class="headerlink"
169172
</div></blockquote>
170173
<p>Also, we use the <a class="reference external" href="https://github.com/CiscoDevNet/ydk-gen">ydk-gen</a> tool to generate the bundles.
171174
This tool is available for anyone to use in order to generate the bundle version in combination with YDK core version of their choice.
172-
For example, the below steps will generate &amp; install the <code class="docutils literal"><span class="pre">cisco-ios-xr</span> <span class="pre">6.5.1</span></code> bundle compatible with <code class="docutils literal"><span class="pre">ydk</span> <span class="pre">core</span> <span class="pre">0.8.0</span></code>
175+
For example, the below steps will generate &amp; install the <cite>cisco-ios-xr 6.5.1</cite> bundle compatible with <cite>ydk core 0.8.5</cite>
173176
(assuming you have already installed the <a class="reference external" href="https://github.com/CiscoDevNet/ydk-py#system-requirements">system dependencies</a>):</p>
174177
<ol class="arabic simple">
175-
<li>Install libydk (taking CentOS as example. For other OS, please see <a class="reference external" href="https://github.com/CiscoDevNet/ydk-py#quick-install">here</a>)</li>
178+
<li>Install libydk (taking CentOS as example. For other OS, please see in <a class="reference external" href="https://github.com/CiscoDevNet/ydk-py#quick-install">ydk-py</a> repository)</li>
176179
</ol>
177-
<div class="highlight-sh"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1</pre></div></td><td class="code"><div class="highlight"><pre><span></span>sudo yum install https://devhub.cisco.com/artifactory/rpm-ydk/0.8.5-beta/libydk-0.8.5-1.x86_64.rpm
180+
<div class="highlight-sh"><div class="highlight"><pre><span></span>sudo yum install https://devhub.cisco.com/artifactory/rpm-ydk/0.8.5-beta/libydk-0.8.5-1.x86_64.rpm
178181
</pre></div>
179-
</td></tr></table></div>
182+
</div>
180183
<ol class="arabic simple" start="2">
181184
<li>Generate and install ydk-py core</li>
182185
</ol>
183-
<div class="highlight-sh"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
184-
2
185-
3
186-
4
187-
5
188-
6</pre></div></td><td class="code"><div class="highlight"><pre><span></span>git clone https://github.com/CiscoDevNet/ydk-gen.git
186+
<div class="highlight-sh"><div class="highlight"><pre><span></span>git clone https://github.com/CiscoDevNet/ydk-gen.git
189187
git checkout tags/0.8.5 -b <span class="m">0</span>.8.5
190188
<span class="nb">cd</span> ydk-gen
191189
pip install -r requirements.txt
192190
./generate --core --python
193191
pip install gen-api/python/ydk/dist/ydk*.tar.gz
194192
</pre></div>
195-
</td></tr></table></div>
193+
</div>
196194
<ol class="arabic simple" start="3">
197195
<li>Generate and install bundle</li>
198196
</ol>
199-
<div class="highlight-sh"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
200-
2</pre></div></td><td class="code"><div class="highlight"><pre><span></span>./generate --bundle profiles/bundles/cisco-ios-xr_6_5_1.json --python -v
197+
<div class="highlight-sh"><div class="highlight"><pre><span></span>./generate --bundle profiles/bundles/cisco-ios-xr_6_5_1.json --python -v
201198
pip install gen-api/python/cisco_ios_xr-bundle/dist/ydk*.tar.gz
202199
</pre></div>
203-
</td></tr></table></div>
200+
</div>
204201
</div>
205202
</div>
206203

0 commit comments

Comments
 (0)