<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Wed Feb 07 22:01:04 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[CXX-1000] Migrate documentation to GitHub Pages</title>
                <link>https://jira.mongodb.org/browse/CXX-1000</link>
                <project id="11980" key="CXX">C++ Driver</project>
                    <description>&lt;p&gt;Our plan is to migrate all documentation to GitHub pages.  This includes:&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;The new Driver Playbook intro docs (rendered by Hugo)&lt;/li&gt;
	&lt;li&gt;CXX11 API docs (doxygen)&lt;/li&gt;
	&lt;li&gt;Legacy API docs (doxygen)&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;The Driver Playbook has an open code review from the docs team and needs to be migrated into a &quot;docs&quot; directory in the master repo.&lt;/p&gt;

&lt;p&gt;We then need automation to build and deploy updated docs on demand.  We should have the capability to build and deploy documentation for legacy branches and point release branches/tags.&lt;/p&gt;</description>
                <environment></environment>
        <key id="310499">CXX-1000</key>
            <summary>Migrate documentation to GitHub Pages</summary>
                <type id="3" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14718&amp;avatarType=issuetype">Task</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="9">Done</resolution>
                                        <assignee username="david.golden@mongodb.com">David Golden</assignee>
                                    <reporter username="david.golden@mongodb.com">David Golden</reporter>
                        <labels>
                    </labels>
                <created>Fri, 19 Aug 2016 18:51:54 +0000</created>
                <updated>Wed, 19 Oct 2016 14:26:45 +0000</updated>
                            <resolved>Wed, 28 Sep 2016 18:21:53 +0000</resolved>
                                                    <fixVersion>3.0.3</fixVersion>
                                    <component>Documentation</component>
                                        <votes>0</votes>
                                    <watches>1</watches>
                                                                                                                <comments>
                            <comment id="1396573" author="xgen-internal-githook" created="Thu, 29 Sep 2016 14:15:24 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;xdg&apos;, u&apos;name&apos;: u&apos;David Golden&apos;, u&apos;email&apos;: u&apos;xdg@xdg.me&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1000&quot; title=&quot;Migrate documentation to GitHub Pages&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1000&quot;&gt;&lt;del&gt;CXX-1000&lt;/del&gt;&lt;/a&gt; Migrate documentation to GitHub Pages&lt;/p&gt;

&lt;p&gt;This commit creates a docs/ directory containing a general set&lt;br/&gt;
of documentation files for use with the hugo static site generator.&lt;br/&gt;
The site generated from these files will be deployed to GitHub Pages&lt;br/&gt;
and supersede the current wiki.&lt;/p&gt;

&lt;p&gt;It also provides CMake targets to generate and deploy both this static&lt;br/&gt;
manual and the doxygen generated API documentation sites for all legacy and&lt;br/&gt;
mongocxx releases.&lt;/p&gt;

&lt;p&gt;The doxygen configurations are generated dynamically to ensure that&lt;br/&gt;
documentation from old releases uses the same formatting and &quot;front page&quot;&lt;br/&gt;
content as current releases.&lt;/p&gt;

&lt;p&gt;The site deployment targets do not create symlinks, which are necessary for&lt;br/&gt;
proper &quot;permalinks&quot; to the latest documentation.  These must be added&lt;br/&gt;
manually:&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;/api/mongocxx-v3 -&amp;gt; /api/mongocxx-3.0.x (for latest x in v3 series)&lt;/li&gt;
	&lt;li&gt;/api/legacy-v1   -&amp;gt; /api/legacy-1.1.x (for latest x in v1 series)&lt;/li&gt;
	&lt;li&gt;/api/current     -&amp;gt; /api/mongocxx-v3&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;For symlinks to work, there must be a `.nojekyll` file at the top of&lt;br/&gt;
the GitHub Pages site.&lt;br/&gt;
Branch: 3.1-dev&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/428607a5dadcbc8de7069b39133572a48a6b87ce&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/428607a5dadcbc8de7069b39133572a48a6b87ce&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1395973" author="david.golden" created="Wed, 28 Sep 2016 18:21:53 +0000"  >&lt;p&gt;Wiki and README pages updated.  The wiki pages point to the top of the manual rather than subpages, so that we don&apos;t wind up with broken wiki links if we choose to reorganize the manual layout later.&lt;/p&gt;</comment>
                            <comment id="1395818" author="david.golden" created="Wed, 28 Sep 2016 17:12:56 +0000"  >&lt;p&gt;Oops.  Shouldn&apos;t resolve this until README and wiki pages point to new docs.&lt;/p&gt;</comment>
                            <comment id="1395809" author="xgen-internal-githook" created="Wed, 28 Sep 2016 17:08:25 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;xdg&apos;, u&apos;name&apos;: u&apos;David Golden&apos;, u&apos;email&apos;: u&apos;xdg@xdg.me&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1000&quot; title=&quot;Migrate documentation to GitHub Pages&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1000&quot;&gt;&lt;del&gt;CXX-1000&lt;/del&gt;&lt;/a&gt; Migrate documentation to GitHub Pages&lt;/p&gt;

&lt;p&gt;This commit creates a docs/ directory containing a general set&lt;br/&gt;
of documentation files for use with the hugo static site generator.&lt;br/&gt;
The site generated from these files will be deployed to GitHub Pages&lt;br/&gt;
and supersede the current wiki.&lt;/p&gt;

&lt;p&gt;It also provides CMake targets to generate and deploy both this static&lt;br/&gt;
manual and the doxygen generated API documentation sites for all legacy and&lt;br/&gt;
mongocxx releases.&lt;/p&gt;

&lt;p&gt;The doxygen configurations are generated dynamically to ensure that&lt;br/&gt;
documentation from old releases uses the same formatting and &quot;front page&quot;&lt;br/&gt;
content as current releases.&lt;/p&gt;

&lt;p&gt;The site deployment targets do not create symlinks, which are necessary for&lt;br/&gt;
proper &quot;permalinks&quot; to the latest documentation.  These must be added&lt;br/&gt;
manually:&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;/api/mongocxx-v3 -&amp;gt; /api/mongocxx-3.0.x (for latest x in v3 series)&lt;/li&gt;
	&lt;li&gt;/api/legacy-v1   -&amp;gt; /api/legacy-1.1.x (for latest x in v1 series)&lt;/li&gt;
	&lt;li&gt;/api/current     -&amp;gt; /api/mongocxx-v3&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;For symlinks to work, there must be a `.nojekyll` file at the top of&lt;br/&gt;
the GitHub Pages site.&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/428607a5dadcbc8de7069b39133572a48a6b87ce&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/428607a5dadcbc8de7069b39133572a48a6b87ce&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1389476" author="david.golden" created="Wed, 21 Sep 2016 02:39:42 +0000"  >&lt;p&gt;&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/pull/539&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/pull/539&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1374084" author="david.golden" created="Wed, 31 Aug 2016 22:22:39 +0000"  >&lt;p&gt;Potentially useful references:&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;&lt;a href=&quot;https://majewsky.wordpress.com/2010/08/14/tip-of-the-day-cmake-and-doxygen/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;Using Cmake to customize Doxygen&lt;/a&gt; and &lt;span class=&quot;error&quot;&gt;&amp;#91;Calling doxygen from Cmake&amp;#93;&lt;/span&gt; &#8211; we could use this for setting version number and version-specific output directories&lt;/li&gt;
&lt;/ul&gt;

</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10011">
                    <name>Depends</name>
                                                                <inwardlinks description="is depended on by">
                                        <issuelink>
            <issuekey id="318414">CXX-1048</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="309879">CXX-996</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="313271">CXX-1013</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="319532">DOCS-8894</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hsowqn:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                    <customfield id="customfield_10557" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="1258">Perl/CXX 2016-09-30</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            </customfields>
    </item>
</channel>
</rss>