Package: canonicalwebteam.discourse
canonicalwebteam.discourseFlask extension to integrate discourse content generated to docs to your website. This project was previously nameddiscourse_docs.Writing documentationDocumentation for how to write documentation pages in Discourse for consumption by this module and how to configure the website to use the module can be foundin the Canonical discourse.Example Flask template for documentation pages can be found inexamplesfolder. Please refer to theREADMEin that folder for more information.InstallInstall the project with pip:pip install canonicalwebteam.discourseYou can add the extension on your project as follows, replacing, at least,base_urlandindex_topic_idwith your own settings:importtalisker.requestsfromcanonicalwebteam.discourseimportDiscourseAPI,Tutorials,TutorialParserapp=Flask("myapp")session=talisker.requests.get_session()discourse=Tutorials(parser=TutorialParser(api=DiscourseAPI(base_url="https://forum.example.com/",session=session),index_topic_id=321,url_prefix="/docs",),document_template="docs/document.html",url_prefix="/docs",)discourse.init_app(app)Once this is added you will need to add the filedocument.htmlto your template folder.Local developmentFor local development, it's best to test this module with one of our website projects likeubuntu.com. For more information, followthis guide (internal only).Running tests, linting and formattingTests can be run withTox:pip3installtox# Install toxtox# Run teststox-elint# Check the format of Python codetox-eformat# Reformat the Python codeInstructions for Engage pages extensionBecause you are viewing a protected topic, you must provideapi_keyandapi_username. You also need an index topic id, which you can get from discourse.ubuntu.com. Your index topic must contain a metadata section. Visit the EngageParser for more information about the structure. You are encouraged to use an blueprint name that does not collide with existent blueprints. The templates must match the ones provided in the parameters indicated.Here is an example of an implementation:engage_pages=EngagePages(api=DiscourseAPI(base_url="https://discourse.ubuntu.com/",session=session,get_topics_query_id=14,api_key=DISCOURSE_API_KEY,# replace with your API keyapi_username=DISCOURSE_API_USERNAME,# replace with correspoding username),category_id=51,page_type="engage-pages",# one of ["engage-pages", "takeovers"]exclude_topics=[]# this is a list of topic ids that we want to exclude from Markdown error checksadditional_metadata_validation=[]# list of additional keys in the metadata table that you want to validate existence for e.g. language)In your project, you need to create your own views:app.add_url_rule("/engage",view_func=build_engage_index(engage_pages))app.add_url_rule("/engage/<path>",view_func=single_engage_page(engage_pages))Wherebuild_engage_indexwould be your view for the list of engage pages, which you can get by using the methodEngagagePages(args).get_index()Whilesingle_engage_pagewould be your single engage pages view, which you can get usingEngagePages(args).get_engage_page(path)Similarly for takeovers, you just need to passpage_type="takeovers".To get a list of takeoversEngagePages(args).get_index()also.To get a list of active takeoversEngagePages(args).parse_active_takeovers().